Completed
Push — master ( 607d48...7e6159 )
by Lars
05:47
created

UTF8::substr_ileft()   B

Complexity

Conditions 5
Paths 5

Size

Total Lines 24
Code Lines 13

Duplication

Lines 24
Ratio 100 %

Code Coverage

Tests 13
CRAP Score 5.0592

Importance

Changes 0
Metric Value
dl 24
loc 24
ccs 13
cts 15
cp 0.8667
rs 8.5125
c 0
b 0
f 0
cc 5
eloc 13
nc 5
nop 2
crap 5.0592
1
<?php
2
3
namespace voku\helper;
4
5
/**
6
 * UTF8-Helper-Class
7
 *
8
 * @package voku\helper
9
 */
10
final class UTF8
11
{
12
  // (CRLF|([ZWNJ-ZWJ]|T+|L*(LV?V+|LV|LVT)T*|L+|[^Control])[Extend]*|[Control])
13
  // This regular expression is a work around for http://bugs.exim.org/1279
14
  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}])';
15
16
  /**
17
   * @var array
18
   */
19
  private static $WIN1252_TO_UTF8 = array(
20
      128 => "\xe2\x82\xac", // EURO SIGN
21
      130 => "\xe2\x80\x9a", // SINGLE LOW-9 QUOTATION MARK
22
      131 => "\xc6\x92", // LATIN SMALL LETTER F WITH HOOK
23
      132 => "\xe2\x80\x9e", // DOUBLE LOW-9 QUOTATION MARK
24
      133 => "\xe2\x80\xa6", // HORIZONTAL ELLIPSIS
25
      134 => "\xe2\x80\xa0", // DAGGER
26
      135 => "\xe2\x80\xa1", // DOUBLE DAGGER
27
      136 => "\xcb\x86", // MODIFIER LETTER CIRCUMFLEX ACCENT
28
      137 => "\xe2\x80\xb0", // PER MILLE SIGN
29
      138 => "\xc5\xa0", // LATIN CAPITAL LETTER S WITH CARON
30
      139 => "\xe2\x80\xb9", // SINGLE LEFT-POINTING ANGLE QUOTE
31
      140 => "\xc5\x92", // LATIN CAPITAL LIGATURE OE
32
      142 => "\xc5\xbd", // LATIN CAPITAL LETTER Z WITH CARON
33
      145 => "\xe2\x80\x98", // LEFT SINGLE QUOTATION MARK
34
      146 => "\xe2\x80\x99", // RIGHT SINGLE QUOTATION MARK
35
      147 => "\xe2\x80\x9c", // LEFT DOUBLE QUOTATION MARK
36
      148 => "\xe2\x80\x9d", // RIGHT DOUBLE QUOTATION MARK
37
      149 => "\xe2\x80\xa2", // BULLET
38
      150 => "\xe2\x80\x93", // EN DASH
39
      151 => "\xe2\x80\x94", // EM DASH
40
      152 => "\xcb\x9c", // SMALL TILDE
41
      153 => "\xe2\x84\xa2", // TRADE MARK SIGN
42
      154 => "\xc5\xa1", // LATIN SMALL LETTER S WITH CARON
43
      155 => "\xe2\x80\xba", // SINGLE RIGHT-POINTING ANGLE QUOTE
44
      156 => "\xc5\x93", // LATIN SMALL LIGATURE OE
45
      158 => "\xc5\xbe", // LATIN SMALL LETTER Z WITH CARON
46
      159 => "\xc5\xb8", // LATIN CAPITAL LETTER Y WITH DIAERESIS
47
      164 => "\xc3\xb1", // ñ
48
      165 => "\xc3\x91", // Ñ
49
  );
50
51
  /**
52
   * @var array
53
   */
54
  private static $CP1252_TO_UTF8 = array(
55
      '€' => '€',
56
      '‚' => '‚',
57
      'ƒ' => 'ƒ',
58
      '„' => '„',
59
      '…' => '…',
60
      '†' => '†',
61
      '‡' => '‡',
62
      'ˆ' => 'ˆ',
63
      '‰' => '‰',
64
      'Š' => 'Š',
65
      '‹' => '‹',
66
      'Œ' => 'Œ',
67
      'Ž' => 'Ž',
68
      '‘' => '‘',
69
      '’' => '’',
70
      '“' => '“',
71
      '”' => '”',
72
      '•' => '•',
73
      '–' => '–',
74
      '—' => '—',
75
      '˜' => '˜',
76
      '™' => '™',
77
      'š' => 'š',
78
      '›' => '›',
79
      'œ' => 'œ',
80
      'ž' => 'ž',
81
      'Ÿ' => 'Ÿ',
82
  );
83
84
  /**
85
   * Bom => Byte-Length
86
   *
87
   * INFO: https://en.wikipedia.org/wiki/Byte_order_mark
88
   *
89
   * @var array
90
   */
91
  private static $BOM = array(
92
      "\xef\xbb\xbf"     => 3, // UTF-8 BOM
93
      ''              => 6, // UTF-8 BOM as "WINDOWS-1252" (one char has [maybe] more then one byte ...)
94
      "\x00\x00\xfe\xff" => 4, // UTF-32 (BE) BOM
95
      '  þÿ'             => 6, // UTF-32 (BE) BOM as "WINDOWS-1252"
96
      "\xff\xfe\x00\x00" => 4, // UTF-32 (LE) BOM
97
      'ÿþ  '             => 6, // UTF-32 (LE) BOM as "WINDOWS-1252"
98
      "\xfe\xff"         => 2, // UTF-16 (BE) BOM
99
      'þÿ'               => 4, // UTF-16 (BE) BOM as "WINDOWS-1252"
100
      "\xff\xfe"         => 2, // UTF-16 (LE) BOM
101
      'ÿþ'               => 4, // UTF-16 (LE) BOM as "WINDOWS-1252"
102
  );
103
104
  /**
105
   * Numeric code point => UTF-8 Character
106
   *
107
   * url: http://www.w3schools.com/charsets/ref_utf_punctuation.asp
108
   *
109
   * @var array
110
   */
111
  private static $WHITESPACE = array(
112
    // NUL Byte
113
    0     => "\x0",
114
    // Tab
115
    9     => "\x9",
116
    // New Line
117
    10    => "\xa",
118
    // Vertical Tab
119
    11    => "\xb",
120
    // Carriage Return
121
    13    => "\xd",
122
    // Ordinary Space
123
    32    => "\x20",
124
    // NO-BREAK SPACE
125
    160   => "\xc2\xa0",
126
    // OGHAM SPACE MARK
127
    5760  => "\xe1\x9a\x80",
128
    // MONGOLIAN VOWEL SEPARATOR
129
    6158  => "\xe1\xa0\x8e",
130
    // EN QUAD
131
    8192  => "\xe2\x80\x80",
132
    // EM QUAD
133
    8193  => "\xe2\x80\x81",
134
    // EN SPACE
135
    8194  => "\xe2\x80\x82",
136
    // EM SPACE
137
    8195  => "\xe2\x80\x83",
138
    // THREE-PER-EM SPACE
139
    8196  => "\xe2\x80\x84",
140
    // FOUR-PER-EM SPACE
141
    8197  => "\xe2\x80\x85",
142
    // SIX-PER-EM SPACE
143
    8198  => "\xe2\x80\x86",
144
    // FIGURE SPACE
145
    8199  => "\xe2\x80\x87",
146
    // PUNCTUATION SPACE
147
    8200  => "\xe2\x80\x88",
148
    // THIN SPACE
149
    8201  => "\xe2\x80\x89",
150
    //HAIR SPACE
151
    8202  => "\xe2\x80\x8a",
152
    // LINE SEPARATOR
153
    8232  => "\xe2\x80\xa8",
154
    // PARAGRAPH SEPARATOR
155
    8233  => "\xe2\x80\xa9",
156
    // NARROW NO-BREAK SPACE
157
    8239  => "\xe2\x80\xaf",
158
    // MEDIUM MATHEMATICAL SPACE
159
    8287  => "\xe2\x81\x9f",
160
    // IDEOGRAPHIC SPACE
161
    12288 => "\xe3\x80\x80",
162
  );
163
164
  /**
165
   * @var array
166
   */
167
  private static $WHITESPACE_TABLE = array(
168
      'SPACE'                     => "\x20",
169
      'NO-BREAK SPACE'            => "\xc2\xa0",
170
      'OGHAM SPACE MARK'          => "\xe1\x9a\x80",
171
      'EN QUAD'                   => "\xe2\x80\x80",
172
      'EM QUAD'                   => "\xe2\x80\x81",
173
      'EN SPACE'                  => "\xe2\x80\x82",
174
      'EM SPACE'                  => "\xe2\x80\x83",
175
      'THREE-PER-EM SPACE'        => "\xe2\x80\x84",
176
      'FOUR-PER-EM SPACE'         => "\xe2\x80\x85",
177
      'SIX-PER-EM SPACE'          => "\xe2\x80\x86",
178
      'FIGURE SPACE'              => "\xe2\x80\x87",
179
      'PUNCTUATION SPACE'         => "\xe2\x80\x88",
180
      'THIN SPACE'                => "\xe2\x80\x89",
181
      'HAIR SPACE'                => "\xe2\x80\x8a",
182
      'LINE SEPARATOR'            => "\xe2\x80\xa8",
183
      'PARAGRAPH SEPARATOR'       => "\xe2\x80\xa9",
184
      'ZERO WIDTH SPACE'          => "\xe2\x80\x8b",
185
      'NARROW NO-BREAK SPACE'     => "\xe2\x80\xaf",
186
      'MEDIUM MATHEMATICAL SPACE' => "\xe2\x81\x9f",
187
      'IDEOGRAPHIC SPACE'         => "\xe3\x80\x80",
188
  );
189
190
  /**
191
   * bidirectional text chars
192
   *
193
   * url: https://www.w3.org/International/questions/qa-bidi-unicode-controls
194
   *
195
   * @var array
196
   */
197
  private static $BIDI_UNI_CODE_CONTROLS_TABLE = array(
198
    // LEFT-TO-RIGHT EMBEDDING (use -> dir = "ltr")
199
    8234 => "\xE2\x80\xAA",
200
    // RIGHT-TO-LEFT EMBEDDING (use -> dir = "rtl")
201
    8235 => "\xE2\x80\xAB",
202
    // POP DIRECTIONAL FORMATTING // (use -> </bdo>)
203
    8236 => "\xE2\x80\xAC",
204
    // LEFT-TO-RIGHT OVERRIDE // (use -> <bdo dir = "ltr">)
205
    8237 => "\xE2\x80\xAD",
206
    // RIGHT-TO-LEFT OVERRIDE // (use -> <bdo dir = "rtl">)
207
    8238 => "\xE2\x80\xAE",
208
    // LEFT-TO-RIGHT ISOLATE // (use -> dir = "ltr")
209
    8294 => "\xE2\x81\xA6",
210
    // RIGHT-TO-LEFT ISOLATE // (use -> dir = "rtl")
211
    8295 => "\xE2\x81\xA7",
212
    // FIRST STRONG ISOLATE // (use -> dir = "auto")
213
    8296 => "\xE2\x81\xA8",
214
    // POP DIRECTIONAL ISOLATE
215
    8297 => "\xE2\x81\xA9",
216
  );
217
218
  /**
219
   * @var array
220
   */
221
  private static $COMMON_CASE_FOLD = array(
222
      'ſ'            => 's',
223
      "\xCD\x85"     => 'ι',
224
      'ς'            => 'σ',
225
      "\xCF\x90"     => 'β',
226
      "\xCF\x91"     => 'θ',
227
      "\xCF\x95"     => 'φ',
228
      "\xCF\x96"     => 'π',
229
      "\xCF\xB0"     => 'κ',
230
      "\xCF\xB1"     => 'ρ',
231
      "\xCF\xB5"     => 'ε',
232
      "\xE1\xBA\x9B" => "\xE1\xB9\xA1",
233
      "\xE1\xBE\xBE" => 'ι',
234
  );
235
236
  /**
237
   * @var array
238
   */
239
  private static $BROKEN_UTF8_FIX = array(
240
      "\xc2\x80" => "\xe2\x82\xac", // EURO SIGN
241
      "\xc2\x82" => "\xe2\x80\x9a", // SINGLE LOW-9 QUOTATION MARK
242
      "\xc2\x83" => "\xc6\x92", // LATIN SMALL LETTER F WITH HOOK
243
      "\xc2\x84" => "\xe2\x80\x9e", // DOUBLE LOW-9 QUOTATION MARK
244
      "\xc2\x85" => "\xe2\x80\xa6", // HORIZONTAL ELLIPSIS
245
      "\xc2\x86" => "\xe2\x80\xa0", // DAGGER
246
      "\xc2\x87" => "\xe2\x80\xa1", // DOUBLE DAGGER
247
      "\xc2\x88" => "\xcb\x86", // MODIFIER LETTER CIRCUMFLEX ACCENT
248
      "\xc2\x89" => "\xe2\x80\xb0", // PER MILLE SIGN
249
      "\xc2\x8a" => "\xc5\xa0", // LATIN CAPITAL LETTER S WITH CARON
250
      "\xc2\x8b" => "\xe2\x80\xb9", // SINGLE LEFT-POINTING ANGLE QUOTE
251
      "\xc2\x8c" => "\xc5\x92", // LATIN CAPITAL LIGATURE OE
252
      "\xc2\x8e" => "\xc5\xbd", // LATIN CAPITAL LETTER Z WITH CARON
253
      "\xc2\x91" => "\xe2\x80\x98", // LEFT SINGLE QUOTATION MARK
254
      "\xc2\x92" => "\xe2\x80\x99", // RIGHT SINGLE QUOTATION MARK
255
      "\xc2\x93" => "\xe2\x80\x9c", // LEFT DOUBLE QUOTATION MARK
256
      "\xc2\x94" => "\xe2\x80\x9d", // RIGHT DOUBLE QUOTATION MARK
257
      "\xc2\x95" => "\xe2\x80\xa2", // BULLET
258
      "\xc2\x96" => "\xe2\x80\x93", // EN DASH
259
      "\xc2\x97" => "\xe2\x80\x94", // EM DASH
260
      "\xc2\x98" => "\xcb\x9c", // SMALL TILDE
261
      "\xc2\x99" => "\xe2\x84\xa2", // TRADE MARK SIGN
262
      "\xc2\x9a" => "\xc5\xa1", // LATIN SMALL LETTER S WITH CARON
263
      "\xc2\x9b" => "\xe2\x80\xba", // SINGLE RIGHT-POINTING ANGLE QUOTE
264
      "\xc2\x9c" => "\xc5\x93", // LATIN SMALL LIGATURE OE
265
      "\xc2\x9e" => "\xc5\xbe", // LATIN SMALL LETTER Z WITH CARON
266
      "\xc2\x9f" => "\xc5\xb8", // LATIN CAPITAL LETTER Y WITH DIAERESIS
267
      'ü'       => 'ü',
268
      'ä'       => 'ä',
269
      'ö'       => 'ö',
270
      'Ö'       => 'Ö',
271
      'ß'       => 'ß',
272
      'Ã '       => 'à',
273
      'á'       => 'á',
274
      'â'       => 'â',
275
      'ã'       => 'ã',
276
      'ù'       => 'ù',
277
      'ú'       => 'ú',
278
      'û'       => 'û',
279
      'Ù'       => 'Ù',
280
      'Ú'       => 'Ú',
281
      'Û'       => 'Û',
282
      'Ü'       => 'Ü',
283
      'ò'       => 'ò',
284
      'ó'       => 'ó',
285
      'ô'       => 'ô',
286
      'è'       => 'è',
287
      'é'       => 'é',
288
      'ê'       => 'ê',
289
      'ë'       => 'ë',
290
      'À'       => 'À',
291
      'Á'       => 'Á',
292
      'Â'       => 'Â',
293
      'Ã'       => 'Ã',
294
      'Ä'       => 'Ä',
295
      'Ã…'       => 'Å',
296
      'Ç'       => 'Ç',
297
      'È'       => 'È',
298
      'É'       => 'É',
299
      'Ê'       => 'Ê',
300
      'Ë'       => 'Ë',
301
      'ÃŒ'       => 'Ì',
302
      'Í'       => 'Í',
303
      'ÃŽ'       => 'Î',
304
      'Ï'       => 'Ï',
305
      'Ñ'       => 'Ñ',
306
      'Ã’'       => 'Ò',
307
      'Ó'       => 'Ó',
308
      'Ô'       => 'Ô',
309
      'Õ'       => 'Õ',
310
      'Ø'       => 'Ø',
311
      'Ã¥'       => 'å',
312
      'æ'       => 'æ',
313
      'ç'       => 'ç',
314
      'ì'       => 'ì',
315
      'í'       => 'í',
316
      'î'       => 'î',
317
      'ï'       => 'ï',
318
      'ð'       => 'ð',
319
      'ñ'       => 'ñ',
320
      'õ'       => 'õ',
321
      'ø'       => 'ø',
322
      'ý'       => 'ý',
323
      'ÿ'       => 'ÿ',
324
      '€'      => '€',
325
      '’'      => '’',
326
  );
327
328
  /**
329
   * @var array
330
   */
331
  private static $UTF8_TO_WIN1252 = array(
332
      "\xe2\x82\xac" => "\x80", // EURO SIGN
333
      "\xe2\x80\x9a" => "\x82", // SINGLE LOW-9 QUOTATION MARK
334
      "\xc6\x92"     => "\x83", // LATIN SMALL LETTER F WITH HOOK
335
      "\xe2\x80\x9e" => "\x84", // DOUBLE LOW-9 QUOTATION MARK
336
      "\xe2\x80\xa6" => "\x85", // HORIZONTAL ELLIPSIS
337
      "\xe2\x80\xa0" => "\x86", // DAGGER
338
      "\xe2\x80\xa1" => "\x87", // DOUBLE DAGGER
339
      "\xcb\x86"     => "\x88", // MODIFIER LETTER CIRCUMFLEX ACCENT
340
      "\xe2\x80\xb0" => "\x89", // PER MILLE SIGN
341
      "\xc5\xa0"     => "\x8a", // LATIN CAPITAL LETTER S WITH CARON
342
      "\xe2\x80\xb9" => "\x8b", // SINGLE LEFT-POINTING ANGLE QUOTE
343
      "\xc5\x92"     => "\x8c", // LATIN CAPITAL LIGATURE OE
344
      "\xc5\xbd"     => "\x8e", // LATIN CAPITAL LETTER Z WITH CARON
345
      "\xe2\x80\x98" => "\x91", // LEFT SINGLE QUOTATION MARK
346
      "\xe2\x80\x99" => "\x92", // RIGHT SINGLE QUOTATION MARK
347
      "\xe2\x80\x9c" => "\x93", // LEFT DOUBLE QUOTATION MARK
348
      "\xe2\x80\x9d" => "\x94", // RIGHT DOUBLE QUOTATION MARK
349
      "\xe2\x80\xa2" => "\x95", // BULLET
350
      "\xe2\x80\x93" => "\x96", // EN DASH
351
      "\xe2\x80\x94" => "\x97", // EM DASH
352
      "\xcb\x9c"     => "\x98", // SMALL TILDE
353
      "\xe2\x84\xa2" => "\x99", // TRADE MARK SIGN
354
      "\xc5\xa1"     => "\x9a", // LATIN SMALL LETTER S WITH CARON
355
      "\xe2\x80\xba" => "\x9b", // SINGLE RIGHT-POINTING ANGLE QUOTE
356
      "\xc5\x93"     => "\x9c", // LATIN SMALL LIGATURE OE
357
      "\xc5\xbe"     => "\x9e", // LATIN SMALL LETTER Z WITH CARON
358
      "\xc5\xb8"     => "\x9f", // LATIN CAPITAL LETTER Y WITH DIAERESIS
359
  );
360
361
  /**
362
   * @var array
363
   */
364
  private static $UTF8_MSWORD = array(
365
      "\xc2\xab"     => '"', // « (U+00AB) in UTF-8
366
      "\xc2\xbb"     => '"', // » (U+00BB) in UTF-8
367
      "\xe2\x80\x98" => "'", // ‘ (U+2018) in UTF-8
368
      "\xe2\x80\x99" => "'", // ’ (U+2019) in UTF-8
369
      "\xe2\x80\x9a" => "'", // ‚ (U+201A) in UTF-8
370
      "\xe2\x80\x9b" => "'", // ‛ (U+201B) in UTF-8
371
      "\xe2\x80\x9c" => '"', // “ (U+201C) in UTF-8
372
      "\xe2\x80\x9d" => '"', // ” (U+201D) in UTF-8
373
      "\xe2\x80\x9e" => '"', // „ (U+201E) in UTF-8
374
      "\xe2\x80\x9f" => '"', // ‟ (U+201F) in UTF-8
375
      "\xe2\x80\xb9" => "'", // ‹ (U+2039) in UTF-8
376
      "\xe2\x80\xba" => "'", // › (U+203A) in UTF-8
377
      "\xe2\x80\x93" => '-', // – (U+2013) in UTF-8
378
      "\xe2\x80\x94" => '-', // — (U+2014) in UTF-8
379
      "\xe2\x80\xa6" => '...' // … (U+2026) in UTF-8
380
  );
381
382
  /**
383
   * @var array
384
   */
385
  private static $ICONV_ENCODING = array(
386
      'ANSI_X3.4-1968',
387
      'ANSI_X3.4-1986',
388
      'ASCII',
389
      'CP367',
390
      'IBM367',
391
      'ISO-IR-6',
392
      'ISO646-US',
393
      'ISO_646.IRV:1991',
394
      'US',
395
      'US-ASCII',
396
      'CSASCII',
397
      'UTF-8',
398
      'ISO-10646-UCS-2',
399
      'UCS-2',
400
      'CSUNICODE',
401
      'UCS-2BE',
402
      'UNICODE-1-1',
403
      'UNICODEBIG',
404
      'CSUNICODE11',
405
      'UCS-2LE',
406
      'UNICODELITTLE',
407
      'ISO-10646-UCS-4',
408
      'UCS-4',
409
      'CSUCS4',
410
      'UCS-4BE',
411
      'UCS-4LE',
412
      'UTF-16',
413
      'UTF-16BE',
414
      'UTF-16LE',
415
      'UTF-32',
416
      'UTF-32BE',
417
      'UTF-32LE',
418
      'UNICODE-1-1-UTF-7',
419
      'UTF-7',
420
      'CSUNICODE11UTF7',
421
      'UCS-2-INTERNAL',
422
      'UCS-2-SWAPPED',
423
      'UCS-4-INTERNAL',
424
      'UCS-4-SWAPPED',
425
      'C99',
426
      'JAVA',
427
      'CP819',
428
      'IBM819',
429
      'ISO-8859-1',
430
      'ISO-IR-100',
431
      'ISO8859-1',
432
      'ISO_8859-1',
433
      'ISO_8859-1:1987',
434
      'L1',
435
      'LATIN1',
436
      'CSISOLATIN1',
437
      'ISO-8859-2',
438
      'ISO-IR-101',
439
      'ISO8859-2',
440
      'ISO_8859-2',
441
      'ISO_8859-2:1987',
442
      'L2',
443
      'LATIN2',
444
      'CSISOLATIN2',
445
      'ISO-8859-3',
446
      'ISO-IR-109',
447
      'ISO8859-3',
448
      'ISO_8859-3',
449
      'ISO_8859-3:1988',
450
      'L3',
451
      'LATIN3',
452
      'CSISOLATIN3',
453
      'ISO-8859-4',
454
      'ISO-IR-110',
455
      'ISO8859-4',
456
      'ISO_8859-4',
457
      'ISO_8859-4:1988',
458
      'L4',
459
      'LATIN4',
460
      'CSISOLATIN4',
461
      'CYRILLIC',
462
      'ISO-8859-5',
463
      'ISO-IR-144',
464
      'ISO8859-5',
465
      'ISO_8859-5',
466
      'ISO_8859-5:1988',
467
      'CSISOLATINCYRILLIC',
468
      'ARABIC',
469
      'ASMO-708',
470
      'ECMA-114',
471
      'ISO-8859-6',
472
      'ISO-IR-127',
473
      'ISO8859-6',
474
      'ISO_8859-6',
475
      'ISO_8859-6:1987',
476
      'CSISOLATINARABIC',
477
      'ECMA-118',
478
      'ELOT_928',
479
      'GREEK',
480
      'GREEK8',
481
      'ISO-8859-7',
482
      'ISO-IR-126',
483
      'ISO8859-7',
484
      'ISO_8859-7',
485
      'ISO_8859-7:1987',
486
      'ISO_8859-7:2003',
487
      'CSISOLATINGREEK',
488
      'HEBREW',
489
      'ISO-8859-8',
490
      'ISO-IR-138',
491
      'ISO8859-8',
492
      'ISO_8859-8',
493
      'ISO_8859-8:1988',
494
      'CSISOLATINHEBREW',
495
      'ISO-8859-9',
496
      'ISO-IR-148',
497
      'ISO8859-9',
498
      'ISO_8859-9',
499
      'ISO_8859-9:1989',
500
      'L5',
501
      'LATIN5',
502
      'CSISOLATIN5',
503
      'ISO-8859-10',
504
      'ISO-IR-157',
505
      'ISO8859-10',
506
      'ISO_8859-10',
507
      'ISO_8859-10:1992',
508
      'L6',
509
      'LATIN6',
510
      'CSISOLATIN6',
511
      'ISO-8859-11',
512
      'ISO8859-11',
513
      'ISO_8859-11',
514
      'ISO-8859-13',
515
      'ISO-IR-179',
516
      'ISO8859-13',
517
      'ISO_8859-13',
518
      'L7',
519
      'LATIN7',
520
      'ISO-8859-14',
521
      'ISO-CELTIC',
522
      'ISO-IR-199',
523
      'ISO8859-14',
524
      'ISO_8859-14',
525
      'ISO_8859-14:1998',
526
      'L8',
527
      'LATIN8',
528
      'ISO-8859-15',
529
      'ISO-IR-203',
530
      'ISO8859-15',
531
      'ISO_8859-15',
532
      'ISO_8859-15:1998',
533
      'LATIN-9',
534
      'ISO-8859-16',
535
      'ISO-IR-226',
536
      'ISO8859-16',
537
      'ISO_8859-16',
538
      'ISO_8859-16:2001',
539
      'L10',
540
      'LATIN10',
541
      'KOI8-R',
542
      'CSKOI8R',
543
      'KOI8-U',
544
      'KOI8-RU',
545
      'CP1250',
546
      'MS-EE',
547
      'WINDOWS-1250',
548
      'CP1251',
549
      'MS-CYRL',
550
      'WINDOWS-1251',
551
      'CP1252',
552
      'MS-ANSI',
553
      'WINDOWS-1252',
554
      'CP1253',
555
      'MS-GREEK',
556
      'WINDOWS-1253',
557
      'CP1254',
558
      'MS-TURK',
559
      'WINDOWS-1254',
560
      'CP1255',
561
      'MS-HEBR',
562
      'WINDOWS-1255',
563
      'CP1256',
564
      'MS-ARAB',
565
      'WINDOWS-1256',
566
      'CP1257',
567
      'WINBALTRIM',
568
      'WINDOWS-1257',
569
      'CP1258',
570
      'WINDOWS-1258',
571
      '850',
572
      'CP850',
573
      'IBM850',
574
      'CSPC850MULTILINGUAL',
575
      '862',
576
      'CP862',
577
      'IBM862',
578
      'CSPC862LATINHEBREW',
579
      '866',
580
      'CP866',
581
      'IBM866',
582
      'CSIBM866',
583
      'MAC',
584
      'MACINTOSH',
585
      'MACROMAN',
586
      'CSMACINTOSH',
587
      'MACCENTRALEUROPE',
588
      'MACICELAND',
589
      'MACCROATIAN',
590
      'MACROMANIA',
591
      'MACCYRILLIC',
592
      'MACUKRAINE',
593
      'MACGREEK',
594
      'MACTURKISH',
595
      'MACHEBREW',
596
      'MACARABIC',
597
      'MACTHAI',
598
      'HP-ROMAN8',
599
      'R8',
600
      'ROMAN8',
601
      'CSHPROMAN8',
602
      'NEXTSTEP',
603
      'ARMSCII-8',
604
      'GEORGIAN-ACADEMY',
605
      'GEORGIAN-PS',
606
      'KOI8-T',
607
      'CP154',
608
      'CYRILLIC-ASIAN',
609
      'PT154',
610
      'PTCP154',
611
      'CSPTCP154',
612
      'KZ-1048',
613
      'RK1048',
614
      'STRK1048-2002',
615
      'CSKZ1048',
616
      'MULELAO-1',
617
      'CP1133',
618
      'IBM-CP1133',
619
      'ISO-IR-166',
620
      'TIS-620',
621
      'TIS620',
622
      'TIS620-0',
623
      'TIS620.2529-1',
624
      'TIS620.2533-0',
625
      'TIS620.2533-1',
626
      'CP874',
627
      'WINDOWS-874',
628
      'VISCII',
629
      'VISCII1.1-1',
630
      'CSVISCII',
631
      'TCVN',
632
      'TCVN-5712',
633
      'TCVN5712-1',
634
      'TCVN5712-1:1993',
635
      'ISO-IR-14',
636
      'ISO646-JP',
637
      'JIS_C6220-1969-RO',
638
      'JP',
639
      'CSISO14JISC6220RO',
640
      'JISX0201-1976',
641
      'JIS_X0201',
642
      'X0201',
643
      'CSHALFWIDTHKATAKANA',
644
      'ISO-IR-87',
645
      'JIS0208',
646
      'JIS_C6226-1983',
647
      'JIS_X0208',
648
      'JIS_X0208-1983',
649
      'JIS_X0208-1990',
650
      'X0208',
651
      'CSISO87JISX0208',
652
      'ISO-IR-159',
653
      'JIS_X0212',
654
      'JIS_X0212-1990',
655
      'JIS_X0212.1990-0',
656
      'X0212',
657
      'CSISO159JISX02121990',
658
      'CN',
659
      'GB_1988-80',
660
      'ISO-IR-57',
661
      'ISO646-CN',
662
      'CSISO57GB1988',
663
      'CHINESE',
664
      'GB_2312-80',
665
      'ISO-IR-58',
666
      'CSISO58GB231280',
667
      'CN-GB-ISOIR165',
668
      'ISO-IR-165',
669
      'ISO-IR-149',
670
      'KOREAN',
671
      'KSC_5601',
672
      'KS_C_5601-1987',
673
      'KS_C_5601-1989',
674
      'CSKSC56011987',
675
      'EUC-JP',
676
      'EUCJP',
677
      'EXTENDED_UNIX_CODE_PACKED_FORMAT_FOR_JAPANESE',
678
      'CSEUCPKDFMTJAPANESE',
679
      'MS_KANJI',
680
      'SHIFT-JIS',
681
      'SHIFT_JIS',
682
      'SJIS',
683
      'CSSHIFTJIS',
684
      'CP932',
685
      'ISO-2022-JP',
686
      'CSISO2022JP',
687
      'ISO-2022-JP-1',
688
      'ISO-2022-JP-2',
689
      'CSISO2022JP2',
690
      'CN-GB',
691
      'EUC-CN',
692
      'EUCCN',
693
      'GB2312',
694
      'CSGB2312',
695
      'GBK',
696
      'CP936',
697
      'MS936',
698
      'WINDOWS-936',
699
      'GB18030',
700
      'ISO-2022-CN',
701
      'CSISO2022CN',
702
      'ISO-2022-CN-EXT',
703
      'HZ',
704
      'HZ-GB-2312',
705
      'EUC-TW',
706
      'EUCTW',
707
      'CSEUCTW',
708
      'BIG-5',
709
      'BIG-FIVE',
710
      'BIG5',
711
      'BIGFIVE',
712
      'CN-BIG5',
713
      'CSBIG5',
714
      'CP950',
715
      'BIG5-HKSCS:1999',
716
      'BIG5-HKSCS:2001',
717
      'BIG5-HKSCS',
718
      'BIG5-HKSCS:2004',
719
      'BIG5HKSCS',
720
      'EUC-KR',
721
      'EUCKR',
722
      'CSEUCKR',
723
      'CP949',
724
      'UHC',
725
      'CP1361',
726
      'JOHAB',
727
      'ISO-2022-KR',
728
      'CSISO2022KR',
729
      'CP856',
730
      'CP922',
731
      'CP943',
732
      'CP1046',
733
      'CP1124',
734
      'CP1129',
735
      'CP1161',
736
      'IBM-1161',
737
      'IBM1161',
738
      'CSIBM1161',
739
      'CP1162',
740
      'IBM-1162',
741
      'IBM1162',
742
      'CSIBM1162',
743
      'CP1163',
744
      'IBM-1163',
745
      'IBM1163',
746
      'CSIBM1163',
747
      'DEC-KANJI',
748
      'DEC-HANYU',
749
      '437',
750
      'CP437',
751
      'IBM437',
752
      'CSPC8CODEPAGE437',
753
      'CP737',
754
      'CP775',
755
      'IBM775',
756
      'CSPC775BALTIC',
757
      '852',
758
      'CP852',
759
      'IBM852',
760
      'CSPCP852',
761
      'CP853',
762
      '855',
763
      'CP855',
764
      'IBM855',
765
      'CSIBM855',
766
      '857',
767
      'CP857',
768
      'IBM857',
769
      'CSIBM857',
770
      'CP858',
771
      '860',
772
      'CP860',
773
      'IBM860',
774
      'CSIBM860',
775
      '861',
776
      'CP-IS',
777
      'CP861',
778
      'IBM861',
779
      'CSIBM861',
780
      '863',
781
      'CP863',
782
      'IBM863',
783
      'CSIBM863',
784
      'CP864',
785
      'IBM864',
786
      'CSIBM864',
787
      '865',
788
      'CP865',
789
      'IBM865',
790
      'CSIBM865',
791
      '869',
792
      'CP-GR',
793
      'CP869',
794
      'IBM869',
795
      'CSIBM869',
796
      'CP1125',
797
      'EUC-JISX0213',
798
      'SHIFT_JISX0213',
799
      'ISO-2022-JP-3',
800
      'BIG5-2003',
801
      'ISO-IR-230',
802
      'TDS565',
803
      'ATARI',
804
      'ATARIST',
805
      'RISCOS-LATIN1',
806
  );
807
808
  /**
809
   * @var array
810
   */
811
  private static $SUPPORT = array();
812
813
  /**
814
   * __construct()
815
   */
816 1
  public function __construct()
817
  {
818 1
    self::checkForSupport();
819 1
  }
820
821
  /**
822
   * Return the character at the specified position: $str[1] like functionality.
823
   *
824
   * @param string $str <p>A UTF-8 string.</p>
825
   * @param int    $pos <p>The position of character to return.</p>
826
   *
827
   * @return string <p>Single Multi-Byte character.</p>
828
   */
829 3
  public static function access($str, $pos)
830
  {
831 3
    $str = (string)$str;
832
833 3
    if (!isset($str[0])) {
834 1
      return '';
835
    }
836
837 3
    $pos = (int)$pos;
838
839 3
    if ($pos < 0) {
840
      return '';
841
    }
842
843 3
    return (string)self::substr($str, $pos, 1);
844
  }
845
846
  /**
847
   * Prepends UTF-8 BOM character to the string and returns the whole string.
848
   *
849
   * INFO: If BOM already existed there, the Input string is returned.
850
   *
851
   * @param string $str <p>The input string.</p>
852
   *
853
   * @return string <p>The output string that contains BOM.</p>
854
   */
855 1
  public static function add_bom_to_string($str)
856
  {
857 1
    if (self::string_has_bom($str) === false) {
858 1
      $str = self::bom() . $str;
859 1
    }
860
861 1
    return $str;
862
  }
863
864
  /**
865
   * Convert binary into an string.
866
   *
867
   * @param mixed $bin 1|0
868
   *
869
   * @return string
870
   */
871 1
  public static function binary_to_str($bin)
872
  {
873 1
    if (!isset($bin[0])) {
874
      return '';
875
    }
876
877 1
    return pack('H*', base_convert($bin, 2, 16));
878
  }
879
880
  /**
881
   * Returns the UTF-8 Byte Order Mark Character.
882
   *
883
   * INFO: take a look at UTF8::$bom for e.g. UTF-16 and UTF-32 BOM values
884
   *
885
   * @return string UTF-8 Byte Order Mark
886
   */
887 2
  public static function bom()
888
  {
889 2
    return "\xef\xbb\xbf";
890
  }
891
892
  /**
893
   * @alias of UTF8::chr_map()
894
   *
895
   * @see   UTF8::chr_map()
896
   *
897
   * @param string|array $callback
898
   * @param string       $str
899
   *
900
   * @return array
901
   */
902 1
  public static function callback($callback, $str)
903
  {
904 1
    return self::chr_map($callback, $str);
905
  }
906
907
  /**
908
   * This method will auto-detect your server environment for UTF-8 support.
909
   *
910
   * INFO: You don't need to run it manually, it will be triggered if it's needed.
911
   */
912 4
  public static function checkForSupport()
913
  {
914 4
    if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
915
916 1
      self::$SUPPORT['already_checked_via_portable_utf8'] = true;
917
918
      // http://php.net/manual/en/book.mbstring.php
919 1
      self::$SUPPORT['mbstring'] = self::mbstring_loaded();
920
921
      if (
922 1
          defined('MB_OVERLOAD_STRING')
923 1
          &&
924 1
          ini_get('mbstring.func_overload') & MB_OVERLOAD_STRING
925 1
      ) {
926
        self::$SUPPORT['mbstring_func_overload'] = true;
927
      } else {
928 1
        self::$SUPPORT['mbstring_func_overload'] = false;
929
      }
930
931
      // http://php.net/manual/en/book.iconv.php
932 1
      self::$SUPPORT['iconv'] = self::iconv_loaded();
933
934
      // http://php.net/manual/en/book.intl.php
935 1
      self::$SUPPORT['intl'] = self::intl_loaded();
936 1
      self::$SUPPORT['intl__transliterator_list_ids'] = array();
937
      if (
938 1
          self::$SUPPORT['intl'] === true
939 1
          &&
940 1
          function_exists('transliterator_list_ids') === true
941 1
      ) {
942 1
        self::$SUPPORT['intl__transliterator_list_ids'] = transliterator_list_ids();
943 1
      }
944
945
      // http://php.net/manual/en/class.intlchar.php
946 1
      self::$SUPPORT['intlChar'] = self::intlChar_loaded();
947
948
      // http://php.net/manual/en/book.pcre.php
949 1
      self::$SUPPORT['pcre_utf8'] = self::pcre_utf8_support();
950 1
    }
951 4
  }
952
953
  /**
954
   * Generates a UTF-8 encoded character from the given code point.
955
   *
956
   * INFO: opposite to UTF8::ord()
957
   *
958
   * @param int    $code_point <p>The code point for which to generate a character.</p>
959
   * @param string $encoding   [optional] <p>Default is UTF-8</p>
960
   *
961
   * @return string|null <p>Multi-Byte character, returns null on failure or empty input.</p>
962
   */
963 10
  public static function chr($code_point, $encoding = 'UTF-8')
964
  {
965
    // init
966 10
    static $CHAR_CACHE = array();
967
968 10
    if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
969
      self::checkForSupport();
970
    }
971
972 10
    if ($encoding !== 'UTF-8') {
973 2
      $encoding = self::normalize_encoding($encoding, 'UTF-8');
974 2
    }
975
976 View Code Duplication
    if (
977
        $encoding !== 'UTF-8'
978 10
        &&
979
        $encoding !== 'WINDOWS-1252'
980 10
        &&
981 1
        self::$SUPPORT['mbstring'] === false
982 10
    ) {
983
      trigger_error('UTF8::chr() without mbstring cannot handle "' . $encoding . '" encoding', E_USER_WARNING);
984
    }
985
986 10
    $cacheKey = $code_point . $encoding;
987 10
    if (isset($CHAR_CACHE[$cacheKey]) === true) {
988 8
      return $CHAR_CACHE[$cacheKey];
989
    }
990
991 9
    if (self::$SUPPORT['intlChar'] === true) {
992
      $str = \IntlChar::chr($code_point);
993
994
      if ($encoding !== 'UTF-8') {
995
        $str = \mb_convert_encoding($str, $encoding, 'UTF-8');
996
      }
997
998
      $CHAR_CACHE[$cacheKey] = $str;
999
      return $str;
1000
    }
1001
1002
    // check type of code_point, only if there is no support for "\IntlChar"
1003 9
    if ((int)$code_point !== $code_point) {
1004 1
      $CHAR_CACHE[$cacheKey] = null;
1005 1
      return null;
1006
    }
1007
1008 9
    if ($code_point <= 0x7F) {
1009 7
      $str = self::chr_and_parse_int($code_point);
1010 9
    } elseif ($code_point <= 0x7FF) {
1011 6
      $str = self::chr_and_parse_int(($code_point >> 6) + 0xC0) .
1012 6
             self::chr_and_parse_int(($code_point & 0x3F) + 0x80);
1013 7
    } elseif ($code_point <= 0xFFFF) {
1014 7
      $str = self::chr_and_parse_int(($code_point >> 12) + 0xE0) .
1015 7
             self::chr_and_parse_int((($code_point >> 6) & 0x3F) + 0x80) .
1016 7
             self::chr_and_parse_int(($code_point & 0x3F) + 0x80);
1017 7
    } else {
1018 1
      $str = self::chr_and_parse_int(($code_point >> 18) + 0xF0) .
1019 1
             self::chr_and_parse_int((($code_point >> 12) & 0x3F) + 0x80) .
1020 1
             self::chr_and_parse_int((($code_point >> 6) & 0x3F) + 0x80) .
1021 1
             self::chr_and_parse_int(($code_point & 0x3F) + 0x80);
1022
    }
1023
1024 9
    if ($encoding !== 'UTF-8') {
1025 1
      $str = \mb_convert_encoding($str, $encoding, 'UTF-8');
1026 1
    }
1027
1028
    // add into static cache
1029 9
    $CHAR_CACHE[$cacheKey] = $str;
1030
1031 9
    return $str;
1032
  }
1033
1034
  /**
1035
   * @param int $int
1036
   *
1037
   * @return string
1038
   */
1039 24
  private static function chr_and_parse_int($int)
1040
  {
1041 24
    return chr((int)$int);
1042
  }
1043
1044
  /**
1045
   * Applies callback to all characters of a string.
1046
   *
1047
   * @param string|array $callback <p>The callback function.</p>
1048
   * @param string       $str      <p>UTF-8 string to run callback on.</p>
1049
   *
1050
   * @return array <p>The outcome of callback.</p>
1051
   */
1052 1
  public static function chr_map($callback, $str)
1053
  {
1054 1
    $chars = self::split($str);
1055
1056 1
    return array_map($callback, $chars);
1057
  }
1058
1059
  /**
1060
   * Generates an array of byte length of each character of a Unicode string.
1061
   *
1062
   * 1 byte => U+0000  - U+007F
1063
   * 2 byte => U+0080  - U+07FF
1064
   * 3 byte => U+0800  - U+FFFF
1065
   * 4 byte => U+10000 - U+10FFFF
1066
   *
1067
   * @param string $str <p>The original Unicode string.</p>
1068
   *
1069
   * @return array <p>An array of byte lengths of each character.</p>
1070
   */
1071 4
  public static function chr_size_list($str)
1072
  {
1073 4
    $str = (string)$str;
1074
1075 4
    if (!isset($str[0])) {
1076 3
      return array();
1077
    }
1078
1079 4
    return array_map(
1080
        function ($data) {
1081 4
          return self::strlen($data, '8BIT');
1082 4
        },
1083 4
        self::split($str)
1084 4
    );
1085
  }
1086
1087
  /**
1088
   * Get a decimal code representation of a specific character.
1089
   *
1090
   * @param string $char <p>The input character.</p>
1091
   *
1092
   * @return int
1093
   */
1094 2
  public static function chr_to_decimal($char)
1095
  {
1096 2
    $char = (string)$char;
1097 2
    $code = self::ord($char[0]);
1098 2
    $bytes = 1;
1099
1100 2
    if (!($code & 0x80)) {
1101
      // 0xxxxxxx
1102 2
      return $code;
1103
    }
1104
1105 2
    if (($code & 0xe0) === 0xc0) {
1106
      // 110xxxxx
1107 2
      $bytes = 2;
1108 2
      $code &= ~0xc0;
1109 2
    } elseif (($code & 0xf0) === 0xe0) {
1110
      // 1110xxxx
1111 2
      $bytes = 3;
1112 2
      $code &= ~0xe0;
1113 2
    } elseif (($code & 0xf8) === 0xf0) {
1114
      // 11110xxx
1115 1
      $bytes = 4;
1116 1
      $code &= ~0xf0;
1117 1
    }
1118
1119 2
    for ($i = 2; $i <= $bytes; $i++) {
1120
      // 10xxxxxx
1121 2
      $code = ($code << 6) + (self::ord($char[$i - 1]) & ~0x80);
1122 2
    }
1123
1124 2
    return $code;
1125
  }
1126
1127
  /**
1128
   * Get hexadecimal code point (U+xxxx) of a UTF-8 encoded character.
1129
   *
1130
   * @param string $char <p>The input character</p>
1131
   * @param string $pfix [optional]
1132
   *
1133
   * @return string <p>The code point encoded as U+xxxx<p>
1134
   */
1135 1
  public static function chr_to_hex($char, $pfix = 'U+')
1136
  {
1137 1
    $char = (string)$char;
1138
1139 1
    if (!isset($char[0])) {
1140 1
      return '';
1141
    }
1142
1143 1
    if ($char === '&#0;') {
1144 1
      $char = '';
1145 1
    }
1146
1147 1
    return self::int_to_hex(self::ord($char), $pfix);
1148
  }
1149
1150
  /**
1151
   * alias for "UTF8::chr_to_decimal()"
1152
   *
1153
   * @see UTF8::chr_to_decimal()
1154
   *
1155
   * @param string $chr
1156
   *
1157
   * @return int
1158
   */
1159 1
  public static function chr_to_int($chr)
1160
  {
1161 1
    return self::chr_to_decimal($chr);
1162
  }
1163
1164
  /**
1165
   * Splits a string into smaller chunks and multiple lines, using the specified line ending character.
1166
   *
1167
   * @param string $body     <p>The original string to be split.</p>
1168
   * @param int    $chunklen [optional] <p>The maximum character length of a chunk.</p>
1169
   * @param string $end      [optional] <p>The character(s) to be inserted at the end of each chunk.</p>
1170
   *
1171
   * @return string <p>The chunked string</p>
1172
   */
1173 1
  public static function chunk_split($body, $chunklen = 76, $end = "\r\n")
1174
  {
1175 1
    return implode($end, self::split($body, $chunklen));
1176
  }
1177
1178
  /**
1179
   * Accepts a string and removes all non-UTF-8 characters from it + extras if needed.
1180
   *
1181
   * @param string $str                     <p>The string to be sanitized.</p>
1182
   * @param bool   $remove_bom              [optional] <p>Set to true, if you need to remove UTF-BOM.</p>
1183
   * @param bool   $normalize_whitespace    [optional] <p>Set to true, if you need to normalize the whitespace.</p>
1184
   * @param bool   $normalize_msword        [optional] <p>Set to true, if you need to normalize MS Word chars e.g.: "…"
1185
   *                                        => "..."</p>
1186
   * @param bool   $keep_non_breaking_space [optional] <p>Set to true, to keep non-breaking-spaces, in combination with
1187
   *                                        $normalize_whitespace</p>
1188
   *
1189
   * @return string <p>Clean UTF-8 encoded string.</p>
1190
   */
1191 56
  public static function clean($str, $remove_bom = false, $normalize_whitespace = false, $normalize_msword = false, $keep_non_breaking_space = false)
1192
  {
1193
    // http://stackoverflow.com/questions/1401317/remove-non-utf8-characters-from-string
1194
    // caused connection reset problem on larger strings
1195
1196
    $regx = '/
1197
      (
1198
        (?: [\x00-\x7F]               # single-byte sequences   0xxxxxxx
1199
        |   [\xC0-\xDF][\x80-\xBF]    # double-byte sequences   110xxxxx 10xxxxxx
1200
        |   [\xE0-\xEF][\x80-\xBF]{2} # triple-byte sequences   1110xxxx 10xxxxxx * 2
1201
        |   [\xF0-\xF7][\x80-\xBF]{3} # quadruple-byte sequence 11110xxx 10xxxxxx * 3
1202
        ){1,100}                      # ...one or more times
1203
      )
1204
    | ( [\x80-\xBF] )                 # invalid byte in range 10000000 - 10111111
1205
    | ( [\xC0-\xFF] )                 # invalid byte in range 11000000 - 11111111
1206 56
    /x';
1207 56
    $str = preg_replace($regx, '$1', $str);
1208
1209 56
    $str = self::replace_diamond_question_mark($str, '');
1210 56
    $str = self::remove_invisible_characters($str);
1211
1212 56
    if ($normalize_whitespace === true) {
1213 36
      $str = self::normalize_whitespace($str, $keep_non_breaking_space);
1214 36
    }
1215
1216 56
    if ($normalize_msword === true) {
1217 15
      $str = self::normalize_msword($str);
1218 15
    }
1219
1220 56
    if ($remove_bom === true) {
1221 35
      $str = self::remove_bom($str);
1222 35
    }
1223
1224 56
    return $str;
1225
  }
1226
1227
  /**
1228
   * Clean-up a and show only printable UTF-8 chars at the end  + fix UTF-8 encoding.
1229
   *
1230
   * @param string $str <p>The input string.</p>
1231
   *
1232
   * @return string
1233
   */
1234 22 View Code Duplication
  public static function cleanup($str)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
1235
  {
1236 22
    $str = (string)$str;
1237
1238 22
    if (!isset($str[0])) {
1239 2
      return '';
1240
    }
1241
1242
    // fixed ISO <-> UTF-8 Errors
1243 22
    $str = self::fix_simple_utf8($str);
1244
1245
    // remove all none UTF-8 symbols
1246
    // && remove diamond question mark (�)
1247
    // && remove remove invisible characters (e.g. "\0")
1248
    // && remove BOM
1249
    // && normalize whitespace chars (but keep non-breaking-spaces)
1250 22
    $str = self::clean($str, true, true, false, true);
1251
1252 22
    return (string)$str;
1253
  }
1254
1255
  /**
1256
   * Accepts a string or a array of strings and returns an array of Unicode code points.
1257
   *
1258
   * INFO: opposite to UTF8::string()
1259
   *
1260
   * @param string|string[] $arg        <p>A UTF-8 encoded string or an array of such strings.</p>
1261
   * @param bool            $u_style    <p>If True, will return code points in U+xxxx format,
1262
   *                                    default, code points will be returned as integers.</p>
1263
   *
1264
   * @return array <p>The array of code points.</p>
1265
   */
1266 7
  public static function codepoints($arg, $u_style = false)
1267
  {
1268 7
    if (is_string($arg) === true) {
1269 7
      $arg = self::split($arg);
1270 7
    }
1271
1272 7
    $arg = array_map(
1273
        array(
1274 7
            '\\voku\\helper\\UTF8',
1275 7
            'ord',
1276 7
        ),
1277
        $arg
1278 7
    );
1279
1280 7
    if ($u_style) {
1281 1
      $arg = array_map(
1282
          array(
1283 1
              '\\voku\\helper\\UTF8',
1284 1
              'int_to_hex',
1285 1
          ),
1286
          $arg
1287 1
      );
1288 1
    }
1289
1290 7
    return $arg;
1291
  }
1292
1293
  /**
1294
   * Returns count of characters used in a string.
1295
   *
1296
   * @param string $str       <p>The input string.</p>
1297
   * @param bool   $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
1298
   *
1299
   * @return array <p>An associative array of Character as keys and
1300
   *               their count as values.</p>
1301
   */
1302 7
  public static function count_chars($str, $cleanUtf8 = false)
1303
  {
1304 7
    return array_count_values(self::split($str, 1, $cleanUtf8));
1305
  }
1306
1307
  /**
1308
   * Converts a int-value into an UTF-8 character.
1309
   *
1310
   * @param mixed $int
1311
   *
1312
   * @return string
1313
   */
1314 5
  public static function decimal_to_chr($int)
1315
  {
1316 5
    if (Bootup::is_php('5.4') === true) {
1317 5
      $flags = ENT_QUOTES | ENT_HTML5;
1318 5
    } else {
1319
      $flags = ENT_QUOTES;
1320
    }
1321
1322 5
    return self::html_entity_decode('&#' . $int . ';', $flags);
1323
  }
1324
1325
  /**
1326
   * Encode a string with a new charset-encoding.
1327
   *
1328
   * INFO:  The different to "UTF8::utf8_encode()" is that this function, try to fix also broken / double encoding,
1329
   *        so you can call this function also on a UTF-8 String and you don't mess the string.
1330
   *
1331
   * @param string $encoding <p>e.g. 'UTF-16', 'UTF-8', 'ISO-8859-1', etc.</p>
1332
   * @param string $str      <p>The input string</p>
1333
   * @param bool   $force    [optional] <p>Force the new encoding (we try to fix broken / double encoding for
1334
   *                         UTF-8)<br> otherwise we auto-detect the current string-encoding</p>
1335
   *
1336
   * @return string
1337
   */
1338 12
  public static function encode($encoding, $str, $force = true)
1339
  {
1340 12
    $str = (string)$str;
1341 12
    $encoding = (string)$encoding;
1342
1343 12
    if (!isset($str[0], $encoding[0])) {
1344 5
      return $str;
1345
    }
1346
1347 12
    if ($encoding !== 'UTF-8') {
1348 2
      $encoding = self::normalize_encoding($encoding, 'UTF-8');
1349 2
    }
1350
1351 12
    if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
1352
      self::checkForSupport();
1353
    }
1354
1355 12
    $encodingDetected = self::str_detect_encoding($str);
1356
1357
    if (
1358
        $encodingDetected !== false
1359 12
        &&
1360
        (
1361
            $force === true
1362 12
            ||
1363
            $encodingDetected !== $encoding
1364 4
        )
1365 12
    ) {
1366
1367
      if (
1368
          $encoding === 'UTF-8'
1369 12
          &&
1370
          (
1371
              $force === true
1372 12
              || $encodingDetected === 'UTF-8'
1373 3
          )
1374 12
      ) {
1375 9
        return self::to_utf8($str);
1376
      }
1377
1378
      if (
1379
          $encoding === 'ISO-8859-1'
1380 5
          &&
1381
          (
1382
              $force === true
1383 2
              || $encodingDetected === 'ISO-8859-1'
1384 1
          )
1385 5
      ) {
1386 1
        return self::to_iso8859($str);
1387
      }
1388
1389 View Code Duplication
      if (
1390
          $encoding !== 'UTF-8'
1391 5
          &&
1392
          $encoding !== 'WINDOWS-1252'
1393 5
          &&
1394 2
          self::$SUPPORT['mbstring'] === false
1395 5
      ) {
1396
        trigger_error('UTF8::encode() without mbstring cannot handle "' . $encoding . '" encoding', E_USER_WARNING);
1397
      }
1398
1399 5
      $strEncoded = \mb_convert_encoding(
1400 5
          $str,
1401 5
          $encoding,
1402
          $encodingDetected
1403 5
      );
1404
1405 5
      if ($strEncoded) {
1406 5
        return $strEncoded;
1407
      }
1408
    }
1409
1410 2
    return $str;
1411
  }
1412
1413
  /**
1414
   * Reads entire file into a string.
1415
   *
1416
   * WARNING: do not use UTF-8 Option ($convertToUtf8) for binary-files (e.g.: images) !!!
1417
   *
1418
   * @link http://php.net/manual/en/function.file-get-contents.php
1419
   *
1420
   * @param string        $filename      <p>
1421
   *                                     Name of the file to read.
1422
   *                                     </p>
1423
   * @param int|false     $flags         [optional] <p>
1424
   *                                     Prior to PHP 6, this parameter is called
1425
   *                                     use_include_path and is a bool.
1426
   *                                     As of PHP 5 the FILE_USE_INCLUDE_PATH can be used
1427
   *                                     to trigger include path
1428
   *                                     search.
1429
   *                                     </p>
1430
   *                                     <p>
1431
   *                                     The value of flags can be any combination of
1432
   *                                     the following flags (with some restrictions), joined with the
1433
   *                                     binary OR (|)
1434
   *                                     operator.
1435
   *                                     </p>
1436
   *                                     <p>
1437
   *                                     <table>
1438
   *                                     Available flags
1439
   *                                     <tr valign="top">
1440
   *                                     <td>Flag</td>
1441
   *                                     <td>Description</td>
1442
   *                                     </tr>
1443
   *                                     <tr valign="top">
1444
   *                                     <td>
1445
   *                                     FILE_USE_INCLUDE_PATH
1446
   *                                     </td>
1447
   *                                     <td>
1448
   *                                     Search for filename in the include directory.
1449
   *                                     See include_path for more
1450
   *                                     information.
1451
   *                                     </td>
1452
   *                                     </tr>
1453
   *                                     <tr valign="top">
1454
   *                                     <td>
1455
   *                                     FILE_TEXT
1456
   *                                     </td>
1457
   *                                     <td>
1458
   *                                     As of PHP 6, the default encoding of the read
1459
   *                                     data is UTF-8. You can specify a different encoding by creating a
1460
   *                                     custom context or by changing the default using
1461
   *                                     stream_default_encoding. This flag cannot be
1462
   *                                     used with FILE_BINARY.
1463
   *                                     </td>
1464
   *                                     </tr>
1465
   *                                     <tr valign="top">
1466
   *                                     <td>
1467
   *                                     FILE_BINARY
1468
   *                                     </td>
1469
   *                                     <td>
1470
   *                                     With this flag, the file is read in binary mode. This is the default
1471
   *                                     setting and cannot be used with FILE_TEXT.
1472
   *                                     </td>
1473
   *                                     </tr>
1474
   *                                     </table>
1475
   *                                     </p>
1476
   * @param resource|null $context       [optional] <p>
1477
   *                                     A valid context resource created with
1478
   *                                     stream_context_create. If you don't need to use a
1479
   *                                     custom context, you can skip this parameter by &null;.
1480
   *                                     </p>
1481
   * @param int|null      $offset        [optional] <p>
1482
   *                                     The offset where the reading starts.
1483
   *                                     </p>
1484
   * @param int|null      $maxLength     [optional] <p>
1485
   *                                     Maximum length of data read. The default is to read until end
1486
   *                                     of file is reached.
1487
   *                                     </p>
1488
   * @param int           $timeout       <p>The time in seconds for the timeout.</p>
1489
   *
1490
   * @param boolean       $convertToUtf8 <strong>WARNING!!!</strong> <p>Maybe you can't use this option for e.g. images
1491
   *                                     or pdf, because they used non default utf-8 chars</p>
1492
   *
1493
   * @return string <p>The function returns the read data or false on failure.</p>
1494
   */
1495 4
  public static function file_get_contents($filename, $flags = null, $context = null, $offset = null, $maxLength = null, $timeout = 10, $convertToUtf8 = true)
1496
  {
1497
    // init
1498 4
    $timeout = (int)$timeout;
1499 4
    $filename = filter_var($filename, FILTER_SANITIZE_STRING);
1500
1501 4
    if ($timeout && $context === null) {
1502 3
      $context = stream_context_create(
1503
          array(
1504
              'http' =>
1505
                  array(
1506 3
                      'timeout' => $timeout,
1507 3
                  ),
1508
          )
1509 3
      );
1510 3
    }
1511
1512 4
    if (!$flags) {
1513 4
      $flags = false;
1514 4
    }
1515
1516 4
    if ($offset === null) {
1517 4
      $offset = 0;
1518 4
    }
1519
1520 4
    if (is_int($maxLength) === true) {
1521 1
      $data = file_get_contents($filename, $flags, $context, $offset, $maxLength);
1522 1
    } else {
1523 4
      $data = file_get_contents($filename, $flags, $context, $offset);
1524
    }
1525
1526
    // return false on error
1527 4
    if ($data === false) {
1528 1
      return false;
1529
    }
1530
1531 3
    if ($convertToUtf8 === true) {
1532 3
      $data = self::encode('UTF-8', $data, false);
1533 3
      $data = self::cleanup($data);
0 ignored issues
show
Bug introduced by
It seems like $data can also be of type array; however, voku\helper\UTF8::cleanup() does only seem to accept string, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
1534 3
    }
1535
1536 3
    return $data;
1537
  }
1538
1539
  /**
1540
   * Checks if a file starts with BOM (Byte Order Mark) character.
1541
   *
1542
   * @param string $file_path <p>Path to a valid file.</p>
1543
   *
1544
   * @return bool <p><strong>true</strong> if the file has BOM at the start, <strong>false</strong> otherwise.</>
1545
   */
1546 1
  public static function file_has_bom($file_path)
1547
  {
1548 1
    return self::string_has_bom(file_get_contents($file_path));
1549
  }
1550
1551
  /**
1552
   * Normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
1553
   *
1554
   * @param mixed  $var
1555
   * @param int    $normalization_form
1556
   * @param string $leading_combining
1557
   *
1558
   * @return mixed
1559
   */
1560 9
  public static function filter($var, $normalization_form = 4 /* n::NFC */, $leading_combining = '◌')
1561
  {
1562 9
    switch (gettype($var)) {
1563 9 View Code Duplication
      case 'array':
1564 3
        foreach ($var as $k => $v) {
1565
          /** @noinspection AlterInForeachInspection */
1566 3
          $var[$k] = self::filter($v, $normalization_form, $leading_combining);
1567 3
        }
1568 3
        break;
1569 9 View Code Duplication
      case 'object':
1570 2
        foreach ($var as $k => $v) {
1571 2
          $var->{$k} = self::filter($v, $normalization_form, $leading_combining);
1572 2
        }
1573 2
        break;
1574 9
      case 'string':
0 ignored issues
show
Coding Style introduced by
The case body in a switch statement must start on the line following the statement.

According to the PSR-2, the body of a case statement must start on the line immediately following the case statement.

switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;

}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
1575
1576 8
        if (false !== strpos($var, "\r")) {
1577
          // Workaround https://bugs.php.net/65732
1578 2
          $var = str_replace(array("\r\n", "\r"), "\n", $var);
1579 2
        }
1580
1581 8
        if (self::is_ascii($var) === false) {
1582
          /** @noinspection PhpUndefinedClassInspection */
1583 8
          if (\Normalizer::isNormalized($var, $normalization_form)) {
1584 6
            $n = '-';
1585 6
          } else {
1586
            /** @noinspection PhpUndefinedClassInspection */
1587 6
            $n = \Normalizer::normalize($var, $normalization_form);
1588
1589 6
            if (isset($n[0])) {
1590 3
              $var = $n;
1591 3
            } else {
1592 5
              $var = self::encode('UTF-8', $var, true);
1593
            }
1594
          }
1595
1596
          if (
1597 8
              $var[0] >= "\x80"
1598 8
              &&
1599 6
              isset($n[0], $leading_combining[0])
1600 8
              &&
1601 5
              preg_match('/^\p{Mn}/u', $var)
1602 8
          ) {
1603
            // Prevent leading combining chars
1604
            // for NFC-safe concatenations.
1605 2
            $var = $leading_combining . $var;
1606 2
          }
1607 8
        }
1608
1609 8
        break;
1610 9
    }
1611
1612 9
    return $var;
1613
  }
1614
1615
  /**
1616
   * "filter_input()"-wrapper with normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
1617
   *
1618
   * Gets a specific external variable by name and optionally filters it
1619
   *
1620
   * @link  http://php.net/manual/en/function.filter-input.php
1621
   *
1622
   * @param int    $type          <p>
1623
   *                              One of <b>INPUT_GET</b>, <b>INPUT_POST</b>,
1624
   *                              <b>INPUT_COOKIE</b>, <b>INPUT_SERVER</b>, or
1625
   *                              <b>INPUT_ENV</b>.
1626
   *                              </p>
1627
   * @param string $variable_name <p>
1628
   *                              Name of a variable to get.
1629
   *                              </p>
1630
   * @param int    $filter        [optional] <p>
1631
   *                              The ID of the filter to apply. The
1632
   *                              manual page lists the available filters.
1633
   *                              </p>
1634
   * @param mixed  $options       [optional] <p>
1635
   *                              Associative array of options or bitwise disjunction of flags. If filter
1636
   *                              accepts options, flags can be provided in "flags" field of array.
1637
   *                              </p>
1638
   *
1639
   * @return mixed Value of the requested variable on success, <b>FALSE</b> if the filter fails,
1640
   * or <b>NULL</b> if the <i>variable_name</i> variable is not set.
1641
   * If the flag <b>FILTER_NULL_ON_FAILURE</b> is used, it
1642
   * returns <b>FALSE</b> if the variable is not set and <b>NULL</b> if the filter fails.
1643
   * @since 5.2.0
1644
   */
1645 View Code Duplication
  public static function filter_input($type, $variable_name, $filter = FILTER_DEFAULT, $options = null)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
1646
  {
1647
    if (4 > func_num_args()) {
1648
      $var = filter_input($type, $variable_name, $filter);
1649
    } else {
1650
      $var = filter_input($type, $variable_name, $filter, $options);
1651
    }
1652
1653
    return self::filter($var);
1654
  }
1655
1656
  /**
1657
   * "filter_input_array()"-wrapper with normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
1658
   *
1659
   * Gets external variables and optionally filters them
1660
   *
1661
   * @link  http://php.net/manual/en/function.filter-input-array.php
1662
   *
1663
   * @param int   $type       <p>
1664
   *                          One of <b>INPUT_GET</b>, <b>INPUT_POST</b>,
1665
   *                          <b>INPUT_COOKIE</b>, <b>INPUT_SERVER</b>, or
1666
   *                          <b>INPUT_ENV</b>.
1667
   *                          </p>
1668
   * @param mixed $definition [optional] <p>
1669
   *                          An array defining the arguments. A valid key is a string
1670
   *                          containing a variable name and a valid value is either a filter type, or an array
1671
   *                          optionally specifying the filter, flags and options. If the value is an
1672
   *                          array, valid keys are filter which specifies the
1673
   *                          filter type,
1674
   *                          flags which specifies any flags that apply to the
1675
   *                          filter, and options which specifies any options that
1676
   *                          apply to the filter. See the example below for a better understanding.
1677
   *                          </p>
1678
   *                          <p>
1679
   *                          This parameter can be also an integer holding a filter constant. Then all values in the
1680
   *                          input array are filtered by this filter.
1681
   *                          </p>
1682
   * @param bool  $add_empty  [optional] <p>
1683
   *                          Add missing keys as <b>NULL</b> to the return value.
1684
   *                          </p>
1685
   *
1686
   * @return mixed An array containing the values of the requested variables on success, or <b>FALSE</b>
1687
   * on failure. An array value will be <b>FALSE</b> if the filter fails, or <b>NULL</b> if
1688
   * the variable is not set. Or if the flag <b>FILTER_NULL_ON_FAILURE</b>
1689
   * is used, it returns <b>FALSE</b> if the variable is not set and <b>NULL</b> if the filter
1690
   * fails.
1691
   * @since 5.2.0
1692
   */
1693 View Code Duplication
  public static function filter_input_array($type, $definition = null, $add_empty = true)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
1694
  {
1695
    if (2 > func_num_args()) {
1696
      $a = filter_input_array($type);
1697
    } else {
1698
      $a = filter_input_array($type, $definition, $add_empty);
1699
    }
1700
1701
    return self::filter($a);
1702
  }
1703
1704
  /**
1705
   * "filter_var()"-wrapper with normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
1706
   *
1707
   * Filters a variable with a specified filter
1708
   *
1709
   * @link  http://php.net/manual/en/function.filter-var.php
1710
   *
1711
   * @param mixed $variable <p>
1712
   *                        Value to filter.
1713
   *                        </p>
1714
   * @param int   $filter   [optional] <p>
1715
   *                        The ID of the filter to apply. The
1716
   *                        manual page lists the available filters.
1717
   *                        </p>
1718
   * @param mixed $options  [optional] <p>
1719
   *                        Associative array of options or bitwise disjunction of flags. If filter
1720
   *                        accepts options, flags can be provided in "flags" field of array. For
1721
   *                        the "callback" filter, callable type should be passed. The
1722
   *                        callback must accept one argument, the value to be filtered, and return
1723
   *                        the value after filtering/sanitizing it.
1724
   *                        </p>
1725
   *                        <p>
1726
   *                        <code>
1727
   *                        // for filters that accept options, use this format
1728
   *                        $options = array(
1729
   *                        'options' => array(
1730
   *                        'default' => 3, // value to return if the filter fails
1731
   *                        // other options here
1732
   *                        'min_range' => 0
1733
   *                        ),
1734
   *                        'flags' => FILTER_FLAG_ALLOW_OCTAL,
1735
   *                        );
1736
   *                        $var = filter_var('0755', FILTER_VALIDATE_INT, $options);
1737
   *                        // for filter that only accept flags, you can pass them directly
1738
   *                        $var = filter_var('oops', FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
1739
   *                        // for filter that only accept flags, you can also pass as an array
1740
   *                        $var = filter_var('oops', FILTER_VALIDATE_BOOLEAN,
1741
   *                        array('flags' => FILTER_NULL_ON_FAILURE));
1742
   *                        // callback validate filter
1743
   *                        function foo($value)
1744
   *                        {
1745
   *                        // Expected format: Surname, GivenNames
1746
   *                        if (strpos($value, ", ") === false) return false;
1747
   *                        list($surname, $givennames) = explode(", ", $value, 2);
1748
   *                        $empty = (empty($surname) || empty($givennames));
1749
   *                        $notstrings = (!is_string($surname) || !is_string($givennames));
1750
   *                        if ($empty || $notstrings) {
1751
   *                        return false;
1752
   *                        } else {
1753
   *                        return $value;
1754
   *                        }
1755
   *                        }
1756
   *                        $var = filter_var('Doe, Jane Sue', FILTER_CALLBACK, array('options' => 'foo'));
1757
   *                        </code>
1758
   *                        </p>
1759
   *
1760
   * @return mixed the filtered data, or <b>FALSE</b> if the filter fails.
1761
   * @since 5.2.0
1762
   */
1763 1 View Code Duplication
  public static function filter_var($variable, $filter = FILTER_DEFAULT, $options = null)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
1764
  {
1765 1
    if (3 > func_num_args()) {
1766 1
      $variable = filter_var($variable, $filter);
1767 1
    } else {
1768 1
      $variable = filter_var($variable, $filter, $options);
1769
    }
1770
1771 1
    return self::filter($variable);
1772
  }
1773
1774
  /**
1775
   * "filter_var_array()"-wrapper with normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
1776
   *
1777
   * Gets multiple variables and optionally filters them
1778
   *
1779
   * @link  http://php.net/manual/en/function.filter-var-array.php
1780
   *
1781
   * @param array $data       <p>
1782
   *                          An array with string keys containing the data to filter.
1783
   *                          </p>
1784
   * @param mixed $definition [optional] <p>
1785
   *                          An array defining the arguments. A valid key is a string
1786
   *                          containing a variable name and a valid value is either a
1787
   *                          filter type, or an
1788
   *                          array optionally specifying the filter, flags and options.
1789
   *                          If the value is an array, valid keys are filter
1790
   *                          which specifies the filter type,
1791
   *                          flags which specifies any flags that apply to the
1792
   *                          filter, and options which specifies any options that
1793
   *                          apply to the filter. See the example below for a better understanding.
1794
   *                          </p>
1795
   *                          <p>
1796
   *                          This parameter can be also an integer holding a filter constant. Then all values in the
1797
   *                          input array are filtered by this filter.
1798
   *                          </p>
1799
   * @param bool  $add_empty  [optional] <p>
1800
   *                          Add missing keys as <b>NULL</b> to the return value.
1801
   *                          </p>
1802
   *
1803
   * @return mixed An array containing the values of the requested variables on success, or <b>FALSE</b>
1804
   * on failure. An array value will be <b>FALSE</b> if the filter fails, or <b>NULL</b> if
1805
   * the variable is not set.
1806
   * @since 5.2.0
1807
   */
1808 1 View Code Duplication
  public static function filter_var_array($data, $definition = null, $add_empty = true)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
1809
  {
1810 1
    if (2 > func_num_args()) {
1811 1
      $a = filter_var_array($data);
1812 1
    } else {
1813 1
      $a = filter_var_array($data, $definition, $add_empty);
1814
    }
1815
1816 1
    return self::filter($a);
1817
  }
1818
1819
  /**
1820
   * Check if the number of unicode characters are not more than the specified integer.
1821
   *
1822
   * @param string $str      The original string to be checked.
1823
   * @param int    $box_size The size in number of chars to be checked against string.
1824
   *
1825
   * @return bool true if string is less than or equal to $box_size, false otherwise.
1826
   */
1827 1
  public static function fits_inside($str, $box_size)
1828
  {
1829 1
    return (self::strlen($str) <= $box_size);
1830
  }
1831
1832
  /**
1833
   * Try to fix simple broken UTF-8 strings.
1834
   *
1835
   * INFO: Take a look at "UTF8::fix_utf8()" if you need a more advanced fix for broken UTF-8 strings.
1836
   *
1837
   * If you received an UTF-8 string that was converted from Windows-1252 as it was ISO-8859-1
1838
   * (ignoring Windows-1252 chars from 80 to 9F) use this function to fix it.
1839
   * See: http://en.wikipedia.org/wiki/Windows-1252
1840
   *
1841
   * @param string $str <p>The input string</p>
1842
   *
1843
   * @return string
1844
   */
1845 27 View Code Duplication
  public static function fix_simple_utf8($str)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
1846
  {
1847
    // init
1848 27
    $str = (string)$str;
1849
1850 27
    if (!isset($str[0])) {
1851 2
      return '';
1852
    }
1853
1854 27
    static $BROKEN_UTF8_TO_UTF8_KEYS_CACHE = null;
1855 27
    static $BROKEN_UTF8_TO_UTF8_VALUES_CACHE = null;
1856
1857 27
    if ($BROKEN_UTF8_TO_UTF8_KEYS_CACHE === null) {
1858 1
      $BROKEN_UTF8_TO_UTF8_KEYS_CACHE = array_keys(self::$BROKEN_UTF8_FIX);
1859 1
      $BROKEN_UTF8_TO_UTF8_VALUES_CACHE = array_values(self::$BROKEN_UTF8_FIX);
1860 1
    }
1861
1862 27
    return str_replace($BROKEN_UTF8_TO_UTF8_KEYS_CACHE, $BROKEN_UTF8_TO_UTF8_VALUES_CACHE, $str);
1863
  }
1864
1865
  /**
1866
   * Fix a double (or multiple) encoded UTF8 string.
1867
   *
1868
   * @param string|string[] $str <p>You can use a string or an array of strings.</p>
1869
   *
1870
   * @return string|string[] <p>Will return the fixed input-"array" or
1871
   *                         the fixed input-"string".</p>
1872
   */
1873 1
  public static function fix_utf8($str)
1874
  {
1875 1
    if (is_array($str) === true) {
1876
1877
      /** @noinspection ForeachSourceInspection */
1878 1
      foreach ($str as $k => $v) {
1879
        /** @noinspection AlterInForeachInspection */
1880
        /** @noinspection OffsetOperationsInspection */
1881 1
        $str[$k] = self::fix_utf8($v);
1882 1
      }
1883
1884 1
      return $str;
1885
    }
1886
1887 1
    $last = '';
1888 1
    while ($last !== $str) {
1889 1
      $last = $str;
1890 1
      $str = self::to_utf8(
1891 1
          self::utf8_decode($str)
0 ignored issues
show
Bug introduced by
It seems like $str defined by self::to_utf8(self::utf8_decode($str)) on line 1890 can also be of type array; however, voku\helper\UTF8::utf8_decode() does only seem to accept string, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
1892 1
      );
1893 1
    }
1894
1895 1
    return $str;
1896
  }
1897
1898
  /**
1899
   * Get character of a specific character.
1900
   *
1901
   * @param string $char
1902
   *
1903
   * @return string <p>'RTL' or 'LTR'</p>
1904
   */
1905 1
  public static function getCharDirection($char)
1906
  {
1907 1
    if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
1908
      self::checkForSupport();
1909
    }
1910
1911 1
    if (self::$SUPPORT['intlChar'] === true) {
1912
      $tmpReturn = \IntlChar::charDirection($char);
1913
1914
      // from "IntlChar"-Class
1915
      $charDirection = array(
1916
          'RTL' => array(1, 13, 14, 15, 21),
1917
          'LTR' => array(0, 11, 12, 20),
1918
      );
1919
1920
      if (in_array($tmpReturn, $charDirection['LTR'], true)) {
1921
        return 'LTR';
1922
      }
1923
1924
      if (in_array($tmpReturn, $charDirection['RTL'], true)) {
1925
        return 'RTL';
1926
      }
1927
    }
1928
1929 1
    $c = static::chr_to_decimal($char);
1930
1931 1
    if (!(0x5be <= $c && 0x10b7f >= $c)) {
1932 1
      return 'LTR';
1933
    }
1934
1935 1
    if (0x85e >= $c) {
1936
1937 1
      if (0x5be === $c ||
1938 1
          0x5c0 === $c ||
1939 1
          0x5c3 === $c ||
1940 1
          0x5c6 === $c ||
1941 1
          (0x5d0 <= $c && 0x5ea >= $c) ||
1942 1
          (0x5f0 <= $c && 0x5f4 >= $c) ||
1943 1
          0x608 === $c ||
1944 1
          0x60b === $c ||
1945 1
          0x60d === $c ||
1946 1
          0x61b === $c ||
1947 1
          (0x61e <= $c && 0x64a >= $c) ||
1948 1
          (0x66d <= $c && 0x66f >= $c) ||
1949 1
          (0x671 <= $c && 0x6d5 >= $c) ||
1950 1
          (0x6e5 <= $c && 0x6e6 >= $c) ||
1951 1
          (0x6ee <= $c && 0x6ef >= $c) ||
1952 1
          (0x6fa <= $c && 0x70d >= $c) ||
1953 1
          0x710 === $c ||
1954 1
          (0x712 <= $c && 0x72f >= $c) ||
1955 1
          (0x74d <= $c && 0x7a5 >= $c) ||
1956 1
          0x7b1 === $c ||
1957 1
          (0x7c0 <= $c && 0x7ea >= $c) ||
1958 1
          (0x7f4 <= $c && 0x7f5 >= $c) ||
1959 1
          0x7fa === $c ||
1960 1
          (0x800 <= $c && 0x815 >= $c) ||
1961 1
          0x81a === $c ||
1962 1
          0x824 === $c ||
1963 1
          0x828 === $c ||
1964 1
          (0x830 <= $c && 0x83e >= $c) ||
1965 1
          (0x840 <= $c && 0x858 >= $c) ||
1966
          0x85e === $c
1967 1
      ) {
1968 1
        return 'RTL';
1969
      }
1970
1971 1
    } elseif (0x200f === $c) {
1972
1973
      return 'RTL';
1974
1975 1
    } elseif (0xfb1d <= $c) {
1976
1977 1
      if (0xfb1d === $c ||
1978 1
          (0xfb1f <= $c && 0xfb28 >= $c) ||
1979 1
          (0xfb2a <= $c && 0xfb36 >= $c) ||
1980 1
          (0xfb38 <= $c && 0xfb3c >= $c) ||
1981 1
          0xfb3e === $c ||
1982 1
          (0xfb40 <= $c && 0xfb41 >= $c) ||
1983 1
          (0xfb43 <= $c && 0xfb44 >= $c) ||
1984 1
          (0xfb46 <= $c && 0xfbc1 >= $c) ||
1985 1
          (0xfbd3 <= $c && 0xfd3d >= $c) ||
1986 1
          (0xfd50 <= $c && 0xfd8f >= $c) ||
1987 1
          (0xfd92 <= $c && 0xfdc7 >= $c) ||
1988 1
          (0xfdf0 <= $c && 0xfdfc >= $c) ||
1989 1
          (0xfe70 <= $c && 0xfe74 >= $c) ||
1990 1
          (0xfe76 <= $c && 0xfefc >= $c) ||
1991 1
          (0x10800 <= $c && 0x10805 >= $c) ||
1992 1
          0x10808 === $c ||
1993 1
          (0x1080a <= $c && 0x10835 >= $c) ||
1994 1
          (0x10837 <= $c && 0x10838 >= $c) ||
1995 1
          0x1083c === $c ||
1996 1
          (0x1083f <= $c && 0x10855 >= $c) ||
1997 1
          (0x10857 <= $c && 0x1085f >= $c) ||
1998 1
          (0x10900 <= $c && 0x1091b >= $c) ||
1999 1
          (0x10920 <= $c && 0x10939 >= $c) ||
2000 1
          0x1093f === $c ||
2001 1
          0x10a00 === $c ||
2002 1
          (0x10a10 <= $c && 0x10a13 >= $c) ||
2003 1
          (0x10a15 <= $c && 0x10a17 >= $c) ||
2004 1
          (0x10a19 <= $c && 0x10a33 >= $c) ||
2005 1
          (0x10a40 <= $c && 0x10a47 >= $c) ||
2006 1
          (0x10a50 <= $c && 0x10a58 >= $c) ||
2007 1
          (0x10a60 <= $c && 0x10a7f >= $c) ||
2008 1
          (0x10b00 <= $c && 0x10b35 >= $c) ||
2009 1
          (0x10b40 <= $c && 0x10b55 >= $c) ||
2010 1
          (0x10b58 <= $c && 0x10b72 >= $c) ||
2011
          (0x10b78 <= $c && 0x10b7f >= $c)
2012 1
      ) {
2013 1
        return 'RTL';
2014
      }
2015
    }
2016
2017 1
    return 'LTR';
2018
  }
2019
2020
  /**
2021
   * get data from "/data/*.ser"
2022
   *
2023
   * @param string $file
2024
   *
2025
   * @return bool|string|array|int <p>Will return false on error.</p>
2026
   */
2027 4
  private static function getData($file)
2028
  {
2029 4
    $file = __DIR__ . '/data/' . $file . '.php';
2030 4
    if (file_exists($file)) {
2031
      /** @noinspection PhpIncludeInspection */
2032 4
      return require $file;
2033
    }
2034
2035 1
    return false;
2036
  }
2037
2038
  /**
2039
   * Check for php-support.
2040
   *
2041
   * @param string|null $key
2042
   *
2043
   * @return mixed <p>Return the full support-"array", if $key === null<br>
2044
   *               return bool-value, if $key is used and available<br>
2045
   *               otherwise return null</p>
2046
   */
2047 7
  public static function getSupportInfo($key = null)
2048
  {
2049 7
    if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
2050
      self::checkForSupport();
2051
    }
2052
2053 7
    if ($key === null) {
2054 2
      return self::$SUPPORT;
2055
    }
2056
2057 5
    if (!isset(self::$SUPPORT[$key])) {
2058
      return null;
2059
    }
2060
2061 5
    return self::$SUPPORT[$key];
2062
  }
2063
2064
  /**
2065
   * alias for "UTF8::string_has_bom()"
2066
   *
2067
   * @see UTF8::string_has_bom()
2068
   *
2069
   * @param string $str
2070
   *
2071
   * @return bool
2072
   *
2073
   * @deprecated <p>use "UTF8::string_has_bom()"</p>
2074
   */
2075
  public static function hasBom($str)
2076
  {
2077
    return self::string_has_bom($str);
2078
  }
2079
2080
  /**
2081
   * Converts a hexadecimal-value into an UTF-8 character.
2082
   *
2083
   * @param string $hexdec <p>The hexadecimal value.</p>
2084
   *
2085
   * @return string|false <p>One single UTF-8 character.</p>
2086
   */
2087 2
  public static function hex_to_chr($hexdec)
2088
  {
2089 2
    return self::decimal_to_chr(hexdec($hexdec));
2090
  }
2091
2092
  /**
2093
   * Converts hexadecimal U+xxxx code point representation to integer.
2094
   *
2095
   * INFO: opposite to UTF8::int_to_hex()
2096
   *
2097
   * @param string $hexDec <p>The hexadecimal code point representation.</p>
2098
   *
2099
   * @return int|false <p>The code point, or false on failure.</p>
2100
   */
2101 1
  public static function hex_to_int($hexDec)
2102
  {
2103 1
    $hexDec = (string)$hexDec;
2104
2105 1
    if (!isset($hexDec[0])) {
2106 1
      return false;
2107
    }
2108
2109 1
    if (preg_match('/^(?:\\\u|U\+|)([a-z0-9]{4,6})$/i', $hexDec, $match)) {
2110 1
      return intval($match[1], 16);
2111
    }
2112
2113 1
    return false;
2114
  }
2115
2116
  /**
2117
   * alias for "UTF8::html_entity_decode()"
2118
   *
2119
   * @see UTF8::html_entity_decode()
2120
   *
2121
   * @param string $str
2122
   * @param int    $flags
2123
   * @param string $encoding
2124
   *
2125
   * @return string
2126
   */
2127 1
  public static function html_decode($str, $flags = null, $encoding = 'UTF-8')
2128
  {
2129 1
    return self::html_entity_decode($str, $flags, $encoding);
2130
  }
2131
2132
  /**
2133
   * Converts a UTF-8 string to a series of HTML numbered entities.
2134
   *
2135
   * INFO: opposite to UTF8::html_decode()
2136
   *
2137
   * @param string $str            <p>The Unicode string to be encoded as numbered entities.</p>
2138
   * @param bool   $keepAsciiChars [optional] <p>Keep ASCII chars.</p>
2139
   * @param string $encoding       [optional] <p>Default is UTF-8</p>
2140
   *
2141
   * @return string <p>HTML numbered entities.</p>
2142
   */
2143 2
  public static function html_encode($str, $keepAsciiChars = false, $encoding = 'UTF-8')
2144
  {
2145
    // init
2146 2
    $str = (string)$str;
2147
2148 2
    if (!isset($str[0])) {
2149 1
      return '';
2150
    }
2151
2152 2
    if ($encoding !== 'UTF-8') {
2153 1
      $encoding = self::normalize_encoding($encoding, 'UTF-8');
2154 1
    }
2155
2156
    # INFO: http://stackoverflow.com/questions/35854535/better-explanation-of-convmap-in-mb-encode-numericentity
2157 2
    if (function_exists('mb_encode_numericentity')) {
2158
2159 2
      $startCode = 0x00;
2160 2
      if ($keepAsciiChars === true) {
2161 1
        $startCode = 0x80;
2162 1
      }
2163
2164 2
      return mb_encode_numericentity(
2165 2
          $str,
2166 2
          array($startCode, 0xfffff, 0, 0xfffff, 0),
2167
          $encoding
2168 2
      );
2169
    }
2170
2171
    return implode(
2172
        '',
2173
        array_map(
2174
            function ($data) use ($keepAsciiChars, $encoding) {
2175
              return self::single_chr_html_encode($data, $keepAsciiChars, $encoding);
2176
            },
2177
            self::split($str)
2178
        )
2179
    );
2180
  }
2181
2182
  /**
2183
   * UTF-8 version of html_entity_decode()
2184
   *
2185
   * The reason we are not using html_entity_decode() by itself is because
2186
   * while it is not technically correct to leave out the semicolon
2187
   * at the end of an entity most browsers will still interpret the entity
2188
   * correctly. html_entity_decode() does not convert entities without
2189
   * semicolons, so we are left with our own little solution here. Bummer.
2190
   *
2191
   * Convert all HTML entities to their applicable characters
2192
   *
2193
   * INFO: opposite to UTF8::html_encode()
2194
   *
2195
   * @link http://php.net/manual/en/function.html-entity-decode.php
2196
   *
2197
   * @param string $str      <p>
2198
   *                         The input string.
2199
   *                         </p>
2200
   * @param int    $flags    [optional] <p>
2201
   *                         A bitmask of one or more of the following flags, which specify how to handle quotes and
2202
   *                         which document type to use. The default is ENT_COMPAT | ENT_HTML401.
2203
   *                         <table>
2204
   *                         Available <i>flags</i> constants
2205
   *                         <tr valign="top">
2206
   *                         <td>Constant Name</td>
2207
   *                         <td>Description</td>
2208
   *                         </tr>
2209
   *                         <tr valign="top">
2210
   *                         <td><b>ENT_COMPAT</b></td>
2211
   *                         <td>Will convert double-quotes and leave single-quotes alone.</td>
2212
   *                         </tr>
2213
   *                         <tr valign="top">
2214
   *                         <td><b>ENT_QUOTES</b></td>
2215
   *                         <td>Will convert both double and single quotes.</td>
2216
   *                         </tr>
2217
   *                         <tr valign="top">
2218
   *                         <td><b>ENT_NOQUOTES</b></td>
2219
   *                         <td>Will leave both double and single quotes unconverted.</td>
2220
   *                         </tr>
2221
   *                         <tr valign="top">
2222
   *                         <td><b>ENT_HTML401</b></td>
2223
   *                         <td>
2224
   *                         Handle code as HTML 4.01.
2225
   *                         </td>
2226
   *                         </tr>
2227
   *                         <tr valign="top">
2228
   *                         <td><b>ENT_XML1</b></td>
2229
   *                         <td>
2230
   *                         Handle code as XML 1.
2231
   *                         </td>
2232
   *                         </tr>
2233
   *                         <tr valign="top">
2234
   *                         <td><b>ENT_XHTML</b></td>
2235
   *                         <td>
2236
   *                         Handle code as XHTML.
2237
   *                         </td>
2238
   *                         </tr>
2239
   *                         <tr valign="top">
2240
   *                         <td><b>ENT_HTML5</b></td>
2241
   *                         <td>
2242
   *                         Handle code as HTML 5.
2243
   *                         </td>
2244
   *                         </tr>
2245
   *                         </table>
2246
   *                         </p>
2247
   * @param string $encoding [optional] <p>Encoding to use.</p>
2248
   *
2249
   * @return string <p>The decoded string.</p>
2250
   */
2251 17
  public static function html_entity_decode($str, $flags = null, $encoding = 'UTF-8')
2252
  {
2253
    // init
2254 17
    $str = (string)$str;
2255
2256 17
    if (!isset($str[0])) {
2257 6
      return '';
2258
    }
2259
2260 17
    if (!isset($str[3])) { // examples: &; || &x;
2261 10
      return $str;
2262
    }
2263
2264
    if (
2265 16
        strpos($str, '&') === false
2266 16
        ||
2267
        (
2268 16
            strpos($str, '&#') === false
2269 16
            &&
2270 10
            strpos($str, ';') === false
2271 10
        )
2272 16
    ) {
2273 9
      return $str;
2274
    }
2275
2276 16
    if ($encoding !== 'UTF-8') {
2277 2
      $encoding = self::normalize_encoding($encoding, 'UTF-8');
2278 2
    }
2279
2280 16
    if ($flags === null) {
2281 5
      if (Bootup::is_php('5.4') === true) {
2282 5
        $flags = ENT_QUOTES | ENT_HTML5;
2283 5
      } else {
2284
        $flags = ENT_QUOTES;
2285
      }
2286 5
    }
2287
2288 View Code Duplication
    if (
2289
        $encoding !== 'UTF-8'
2290 16
        &&
2291
        $encoding !== 'WINDOWS-1252'
2292 16
        &&
2293 2
        self::$SUPPORT['mbstring'] === false
2294 16
    ) {
2295
      trigger_error('UTF8::html_entity_decode() without mbstring cannot handle "' . $encoding . '" encoding', E_USER_WARNING);
2296
    }
2297
2298
    do {
2299 16
      $str_compare = $str;
2300
2301 16
      $str = preg_replace_callback(
2302 16
          "/&#\d{2,6};/",
2303
          function ($matches) use ($encoding) {
2304 14
            $returnTmp = \mb_convert_encoding($matches[0], $encoding, 'HTML-ENTITIES');
2305
2306 14
            if ($returnTmp !== '"' && $returnTmp !== "'") {
2307 13
              return $returnTmp;
2308
            }
2309
2310 7
            return $matches[0];
2311 16
          },
2312
          $str
2313 16
      );
2314
2315
      // decode numeric & UTF16 two byte entities
2316 16
      $str = html_entity_decode(
2317 16
          preg_replace('/(&#(?:x0*[0-9a-f]{2,6}(?![0-9a-f;])|(?:0*\d{2,6}(?![0-9;]))))/iS', '$1;', $str),
2318 16
          $flags,
2319
          $encoding
2320 16
      );
2321
2322 16
    } while ($str_compare !== $str);
2323
2324 16
    return $str;
2325
  }
2326
2327
  /**
2328
   * Convert all applicable characters to HTML entities: UTF-8 version of htmlentities()
2329
   *
2330
   * @link http://php.net/manual/en/function.htmlentities.php
2331
   *
2332
   * @param string $str           <p>
2333
   *                              The input string.
2334
   *                              </p>
2335
   * @param int    $flags         [optional] <p>
2336
   *                              A bitmask of one or more of the following flags, which specify how to handle quotes,
2337
   *                              invalid code unit sequences and the used document type. The default is
2338
   *                              ENT_COMPAT | ENT_HTML401.
2339
   *                              <table>
2340
   *                              Available <i>flags</i> constants
2341
   *                              <tr valign="top">
2342
   *                              <td>Constant Name</td>
2343
   *                              <td>Description</td>
2344
   *                              </tr>
2345
   *                              <tr valign="top">
2346
   *                              <td><b>ENT_COMPAT</b></td>
2347
   *                              <td>Will convert double-quotes and leave single-quotes alone.</td>
2348
   *                              </tr>
2349
   *                              <tr valign="top">
2350
   *                              <td><b>ENT_QUOTES</b></td>
2351
   *                              <td>Will convert both double and single quotes.</td>
2352
   *                              </tr>
2353
   *                              <tr valign="top">
2354
   *                              <td><b>ENT_NOQUOTES</b></td>
2355
   *                              <td>Will leave both double and single quotes unconverted.</td>
2356
   *                              </tr>
2357
   *                              <tr valign="top">
2358
   *                              <td><b>ENT_IGNORE</b></td>
2359
   *                              <td>
2360
   *                              Silently discard invalid code unit sequences instead of returning
2361
   *                              an empty string. Using this flag is discouraged as it
2362
   *                              may have security implications.
2363
   *                              </td>
2364
   *                              </tr>
2365
   *                              <tr valign="top">
2366
   *                              <td><b>ENT_SUBSTITUTE</b></td>
2367
   *                              <td>
2368
   *                              Replace invalid code unit sequences with a Unicode Replacement Character
2369
   *                              U+FFFD (UTF-8) or &#38;#38;#FFFD; (otherwise) instead of returning an empty string.
2370
   *                              </td>
2371
   *                              </tr>
2372
   *                              <tr valign="top">
2373
   *                              <td><b>ENT_DISALLOWED</b></td>
2374
   *                              <td>
2375
   *                              Replace invalid code points for the given document type with a
2376
   *                              Unicode Replacement Character U+FFFD (UTF-8) or &#38;#38;#FFFD;
2377
   *                              (otherwise) instead of leaving them as is. This may be useful, for
2378
   *                              instance, to ensure the well-formedness of XML documents with
2379
   *                              embedded external content.
2380
   *                              </td>
2381
   *                              </tr>
2382
   *                              <tr valign="top">
2383
   *                              <td><b>ENT_HTML401</b></td>
2384
   *                              <td>
2385
   *                              Handle code as HTML 4.01.
2386
   *                              </td>
2387
   *                              </tr>
2388
   *                              <tr valign="top">
2389
   *                              <td><b>ENT_XML1</b></td>
2390
   *                              <td>
2391
   *                              Handle code as XML 1.
2392
   *                              </td>
2393
   *                              </tr>
2394
   *                              <tr valign="top">
2395
   *                              <td><b>ENT_XHTML</b></td>
2396
   *                              <td>
2397
   *                              Handle code as XHTML.
2398
   *                              </td>
2399
   *                              </tr>
2400
   *                              <tr valign="top">
2401
   *                              <td><b>ENT_HTML5</b></td>
2402
   *                              <td>
2403
   *                              Handle code as HTML 5.
2404
   *                              </td>
2405
   *                              </tr>
2406
   *                              </table>
2407
   *                              </p>
2408
   * @param string $encoding      [optional] <p>
2409
   *                              Like <b>htmlspecialchars</b>,
2410
   *                              <b>htmlentities</b> takes an optional third argument
2411
   *                              <i>encoding</i> which defines encoding used in
2412
   *                              conversion.
2413
   *                              Although this argument is technically optional, you are highly
2414
   *                              encouraged to specify the correct value for your code.
2415
   *                              </p>
2416
   * @param bool   $double_encode [optional] <p>
2417
   *                              When <i>double_encode</i> is turned off PHP will not
2418
   *                              encode existing html entities. The default is to convert everything.
2419
   *                              </p>
2420
   *
2421
   *
2422
   * @return string the encoded string.
2423
   * </p>
2424
   * <p>
2425
   * If the input <i>string</i> contains an invalid code unit
2426
   * sequence within the given <i>encoding</i> an empty string
2427
   * will be returned, unless either the <b>ENT_IGNORE</b> or
2428
   * <b>ENT_SUBSTITUTE</b> flags are set.
2429
   */
2430 2
  public static function htmlentities($str, $flags = ENT_COMPAT, $encoding = 'UTF-8', $double_encode = true)
2431
  {
2432 2
    if ($encoding !== 'UTF-8') {
2433 1
      $encoding = self::normalize_encoding($encoding, 'UTF-8');
2434 1
    }
2435
2436 2
    $str = htmlentities($str, $flags, $encoding, $double_encode);
2437
2438
    /**
2439
     * PHP doesn't replace a backslash to its html entity since this is something
2440
     * that's mostly used to escape characters when inserting in a database. Since
2441
     * we're using a decent database layer, we don't need this shit and we're replacing
2442
     * the double backslashes by its' html entity equivalent.
2443
     *
2444
     * https://github.com/forkcms/library/blob/master/spoon/filter/filter.php#L303
2445
     */
2446 2
    $str = str_replace('\\', '&#92;', $str);
2447
2448 2
    if ($encoding !== 'UTF-8') {
2449 1
      return $str;
2450
    }
2451
2452 2
    $byteLengths = self::chr_size_list($str);
2453 2
    $search = array();
2454 2
    $replacements = array();
2455 2
    foreach ($byteLengths as $counter => $byteLength) {
2456 2
      if ($byteLength >= 3) {
2457 1
        $char = self::access($str, $counter);
2458
2459 1
        if (!isset($replacements[$char])) {
2460 1
          $search[$char] = $char;
2461 1
          $replacements[$char] = self::html_encode($char);
2462 1
        }
2463 1
      }
2464 2
    }
2465
2466 2
    return str_replace($search, $replacements, $str);
2467
  }
2468
2469
  /**
2470
   * Convert only special characters to HTML entities: UTF-8 version of htmlspecialchars()
2471
   *
2472
   * INFO: Take a look at "UTF8::htmlentities()"
2473
   *
2474
   * @link http://php.net/manual/en/function.htmlspecialchars.php
2475
   *
2476
   * @param string $str           <p>
2477
   *                              The string being converted.
2478
   *                              </p>
2479
   * @param int    $flags         [optional] <p>
2480
   *                              A bitmask of one or more of the following flags, which specify how to handle quotes,
2481
   *                              invalid code unit sequences and the used document type. The default is
2482
   *                              ENT_COMPAT | ENT_HTML401.
2483
   *                              <table>
2484
   *                              Available <i>flags</i> constants
2485
   *                              <tr valign="top">
2486
   *                              <td>Constant Name</td>
2487
   *                              <td>Description</td>
2488
   *                              </tr>
2489
   *                              <tr valign="top">
2490
   *                              <td><b>ENT_COMPAT</b></td>
2491
   *                              <td>Will convert double-quotes and leave single-quotes alone.</td>
2492
   *                              </tr>
2493
   *                              <tr valign="top">
2494
   *                              <td><b>ENT_QUOTES</b></td>
2495
   *                              <td>Will convert both double and single quotes.</td>
2496
   *                              </tr>
2497
   *                              <tr valign="top">
2498
   *                              <td><b>ENT_NOQUOTES</b></td>
2499
   *                              <td>Will leave both double and single quotes unconverted.</td>
2500
   *                              </tr>
2501
   *                              <tr valign="top">
2502
   *                              <td><b>ENT_IGNORE</b></td>
2503
   *                              <td>
2504
   *                              Silently discard invalid code unit sequences instead of returning
2505
   *                              an empty string. Using this flag is discouraged as it
2506
   *                              may have security implications.
2507
   *                              </td>
2508
   *                              </tr>
2509
   *                              <tr valign="top">
2510
   *                              <td><b>ENT_SUBSTITUTE</b></td>
2511
   *                              <td>
2512
   *                              Replace invalid code unit sequences with a Unicode Replacement Character
2513
   *                              U+FFFD (UTF-8) or &#38;#38;#FFFD; (otherwise) instead of returning an empty string.
2514
   *                              </td>
2515
   *                              </tr>
2516
   *                              <tr valign="top">
2517
   *                              <td><b>ENT_DISALLOWED</b></td>
2518
   *                              <td>
2519
   *                              Replace invalid code points for the given document type with a
2520
   *                              Unicode Replacement Character U+FFFD (UTF-8) or &#38;#38;#FFFD;
2521
   *                              (otherwise) instead of leaving them as is. This may be useful, for
2522
   *                              instance, to ensure the well-formedness of XML documents with
2523
   *                              embedded external content.
2524
   *                              </td>
2525
   *                              </tr>
2526
   *                              <tr valign="top">
2527
   *                              <td><b>ENT_HTML401</b></td>
2528
   *                              <td>
2529
   *                              Handle code as HTML 4.01.
2530
   *                              </td>
2531
   *                              </tr>
2532
   *                              <tr valign="top">
2533
   *                              <td><b>ENT_XML1</b></td>
2534
   *                              <td>
2535
   *                              Handle code as XML 1.
2536
   *                              </td>
2537
   *                              </tr>
2538
   *                              <tr valign="top">
2539
   *                              <td><b>ENT_XHTML</b></td>
2540
   *                              <td>
2541
   *                              Handle code as XHTML.
2542
   *                              </td>
2543
   *                              </tr>
2544
   *                              <tr valign="top">
2545
   *                              <td><b>ENT_HTML5</b></td>
2546
   *                              <td>
2547
   *                              Handle code as HTML 5.
2548
   *                              </td>
2549
   *                              </tr>
2550
   *                              </table>
2551
   *                              </p>
2552
   * @param string $encoding      [optional] <p>
2553
   *                              Defines encoding used in conversion.
2554
   *                              </p>
2555
   *                              <p>
2556
   *                              For the purposes of this function, the encodings
2557
   *                              ISO-8859-1, ISO-8859-15,
2558
   *                              UTF-8, cp866,
2559
   *                              cp1251, cp1252, and
2560
   *                              KOI8-R are effectively equivalent, provided the
2561
   *                              <i>string</i> itself is valid for the encoding, as
2562
   *                              the characters affected by <b>htmlspecialchars</b> occupy
2563
   *                              the same positions in all of these encodings.
2564
   *                              </p>
2565
   * @param bool   $double_encode [optional] <p>
2566
   *                              When <i>double_encode</i> is turned off PHP will not
2567
   *                              encode existing html entities, the default is to convert everything.
2568
   *                              </p>
2569
   *
2570
   * @return string The converted string.
2571
   * </p>
2572
   * <p>
2573
   * If the input <i>string</i> contains an invalid code unit
2574
   * sequence within the given <i>encoding</i> an empty string
2575
   * will be returned, unless either the <b>ENT_IGNORE</b> or
2576
   * <b>ENT_SUBSTITUTE</b> flags are set.
2577
   */
2578 1
  public static function htmlspecialchars($str, $flags = ENT_COMPAT, $encoding = 'UTF-8', $double_encode = true)
2579
  {
2580 1
    if ($encoding !== 'UTF-8') {
2581 1
      $encoding = self::normalize_encoding($encoding, 'UTF-8');
2582 1
    }
2583
2584 1
    return htmlspecialchars($str, $flags, $encoding, $double_encode);
2585
  }
2586
2587
  /**
2588
   * Checks whether iconv is available on the server.
2589
   *
2590
   * @return bool <p><strong>true</strong> if available, <strong>false</strong> otherwise.</p>
2591
   */
2592 1
  public static function iconv_loaded()
2593
  {
2594 1
    $return = extension_loaded('iconv') ? true : false;
2595
2596
    // INFO: "default_charset" is already set by the "Bootup"-class
2597
2598 1
    if (Bootup::is_php('5.6') === false) {
2599
      // INFO: "iconv_set_encoding" is deprecated since PHP >= 5.6
2600 1
      iconv_set_encoding('input_encoding', 'UTF-8');
2601 1
      iconv_set_encoding('output_encoding', 'UTF-8');
2602 1
      iconv_set_encoding('internal_encoding', 'UTF-8');
2603 1
    }
2604
2605 1
    return $return;
2606
  }
2607
2608
  /**
2609
   * alias for "UTF8::decimal_to_chr()"
2610
   *
2611
   * @see UTF8::decimal_to_chr()
2612
   *
2613
   * @param mixed $int
2614
   *
2615
   * @return string
2616
   */
2617 2
  public static function int_to_chr($int)
2618
  {
2619 2
    return self::decimal_to_chr($int);
2620
  }
2621
2622
  /**
2623
   * Converts Integer to hexadecimal U+xxxx code point representation.
2624
   *
2625
   * INFO: opposite to UTF8::hex_to_int()
2626
   *
2627
   * @param int    $int  <p>The integer to be converted to hexadecimal code point.</p>
2628
   * @param string $pfix [optional]
2629
   *
2630
   * @return string <p>The code point, or empty string on failure.</p>
2631
   */
2632 3
  public static function int_to_hex($int, $pfix = 'U+')
2633
  {
2634 3
    if ((int)$int === $int) {
2635 3
      $hex = dechex($int);
2636
2637 3
      $hex = (strlen($hex) < 4 ? substr('0000' . $hex, -4) : $hex);
2638
2639 3
      return $pfix . $hex;
2640
    }
2641
2642 1
    return '';
2643
  }
2644
2645
  /**
2646
   * Checks whether intl-char is available on the server.
2647
   *
2648
   * @return bool <p><strong>true</strong> if available, <strong>false</strong> otherwise.</p>
2649
   */
2650 1
  public static function intlChar_loaded()
2651
  {
2652
    return (
2653 1
        Bootup::is_php('7.0') === true
2654 1
        &&
2655
        class_exists('IntlChar') === true
2656 1
    );
2657
  }
2658
2659
  /**
2660
   * Checks whether intl is available on the server.
2661
   *
2662
   * @return bool <p><strong>true</strong> if available, <strong>false</strong> otherwise.</p>
2663
   */
2664 4
  public static function intl_loaded()
2665
  {
2666 4
    return extension_loaded('intl') ? true : false;
2667
  }
2668
2669
  /**
2670
   * alias for "UTF8::is_ascii()"
2671
   *
2672
   * @see UTF8::is_ascii()
2673
   *
2674
   * @param string $str
2675
   *
2676
   * @return boolean
2677
   *
2678
   * @deprecated <p>use "UTF8::is_ascii()"</p>
2679
   */
2680
  public static function isAscii($str)
2681
  {
2682
    return self::is_ascii($str);
2683
  }
2684
2685
  /**
2686
   * alias for "UTF8::is_base64()"
2687
   *
2688
   * @see UTF8::is_base64()
2689
   *
2690
   * @param string $str
2691
   *
2692
   * @return bool
2693
   *
2694
   * @deprecated <p>use "UTF8::is_base64()"</p>
2695
   */
2696
  public static function isBase64($str)
2697
  {
2698
    return self::is_base64($str);
2699
  }
2700
2701
  /**
2702
   * alias for "UTF8::is_binary()"
2703
   *
2704
   * @see UTF8::is_binary()
2705
   *
2706
   * @param string $str
2707
   *
2708
   * @return bool
2709
   *
2710
   * @deprecated <p>use "UTF8::is_binary()"</p>
2711
   */
2712
  public static function isBinary($str)
2713
  {
2714
    return self::is_binary($str);
2715
  }
2716
2717
  /**
2718
   * alias for "UTF8::is_bom()"
2719
   *
2720
   * @see UTF8::is_bom()
2721
   *
2722
   * @param string $utf8_chr
2723
   *
2724
   * @return boolean
2725
   *
2726
   * @deprecated <p>use "UTF8::is_bom()"</p>
2727
   */
2728
  public static function isBom($utf8_chr)
2729
  {
2730
    return self::is_bom($utf8_chr);
2731
  }
2732
2733
  /**
2734
   * alias for "UTF8::is_html()"
2735
   *
2736
   * @see UTF8::is_html()
2737
   *
2738
   * @param string $str
2739
   *
2740
   * @return boolean
2741
   *
2742
   * @deprecated <p>use "UTF8::is_html()"</p>
2743
   */
2744
  public static function isHtml($str)
2745
  {
2746
    return self::is_html($str);
2747
  }
2748
2749
  /**
2750
   * alias for "UTF8::is_json()"
2751
   *
2752
   * @see UTF8::is_json()
2753
   *
2754
   * @param string $str
2755
   *
2756
   * @return bool
2757
   *
2758
   * @deprecated <p>use "UTF8::is_json()"</p>
2759
   */
2760
  public static function isJson($str)
2761
  {
2762
    return self::is_json($str);
2763
  }
2764
2765
  /**
2766
   * alias for "UTF8::is_utf16()"
2767
   *
2768
   * @see UTF8::is_utf16()
2769
   *
2770
   * @param string $str
2771
   *
2772
   * @return int|false false if is't not UTF16, 1 for UTF-16LE, 2 for UTF-16BE.
2773
   *
2774
   * @deprecated <p>use "UTF8::is_utf16()"</p>
2775
   */
2776
  public static function isUtf16($str)
2777
  {
2778
    return self::is_utf16($str);
2779
  }
2780
2781
  /**
2782
   * alias for "UTF8::is_utf32()"
2783
   *
2784
   * @see UTF8::is_utf32()
2785
   *
2786
   * @param string $str
2787
   *
2788
   * @return int|false false if is't not UTF16, 1 for UTF-32LE, 2 for UTF-32BE.
2789
   *
2790
   * @deprecated <p>use "UTF8::is_utf32()"</p>
2791
   */
2792
  public static function isUtf32($str)
2793
  {
2794
    return self::is_utf32($str);
2795
  }
2796
2797
  /**
2798
   * alias for "UTF8::is_utf8()"
2799
   *
2800
   * @see UTF8::is_utf8()
2801
   *
2802
   * @param string $str
2803
   * @param bool   $strict
2804
   *
2805
   * @return bool
2806
   *
2807
   * @deprecated <p>use "UTF8::is_utf8()"</p>
2808
   */
2809
  public static function isUtf8($str, $strict = false)
2810
  {
2811
    return self::is_utf8($str, $strict);
2812
  }
2813
2814
  /**
2815
   * Checks if a string is 7 bit ASCII.
2816
   *
2817
   * @param string $str <p>The string to check.</p>
2818
   *
2819
   * @return bool <p>
2820
   *              <strong>true</strong> if it is ASCII<br>
2821
   *              <strong>false</strong> otherwise
2822
   *              </p>
2823
   */
2824 52
  public static function is_ascii($str)
2825
  {
2826 52
    $str = (string)$str;
2827
2828 52
    if (!isset($str[0])) {
2829 6
      return true;
2830
    }
2831
2832 51
    return (bool)!preg_match('/[^\x09\x10\x13\x0A\x0D\x20-\x7E]/', $str);
2833
  }
2834
2835
  /**
2836
   * Returns true if the string is base64 encoded, false otherwise.
2837
   *
2838
   * @param string $str <p>The input string.</p>
2839
   *
2840
   * @return bool <p>Whether or not $str is base64 encoded.</p>
2841
   */
2842 1
  public static function is_base64($str)
2843
  {
2844 1
    $str = (string)$str;
2845
2846 1
    if (!isset($str[0])) {
2847 1
      return false;
2848
    }
2849
2850 1
    $base64String = (string)base64_decode($str, true);
2851 1
    if ($base64String && base64_encode($base64String) === $str) {
2852 1
      return true;
2853
    }
2854
2855 1
    return false;
2856
  }
2857
2858
  /**
2859
   * Check if the input is binary... (is look like a hack).
2860
   *
2861
   * @param mixed $input
2862
   *
2863
   * @return bool
2864
   */
2865 17
  public static function is_binary($input)
2866
  {
2867 17
    $input = (string)$input;
2868
2869 17
    if (!isset($input[0])) {
2870 4
      return false;
2871
    }
2872
2873 17
    if (preg_match('~^[01]+$~', $input)) {
2874 4
      return true;
2875
    }
2876
2877 17
    $testLength = strlen($input);
2878 17
    if ($testLength && substr_count($input, "\x0") / $testLength > 0.3) {
2879 5
      return true;
2880
    }
2881
2882 16
    if (substr_count($input, "\x00") > 0) {
2883 1
      return true;
2884
    }
2885
2886 16
    return false;
2887
  }
2888
2889
  /**
2890
   * Check if the file is binary.
2891
   *
2892
   * @param string $file
2893
   *
2894
   * @return boolean
2895
   */
2896
  public static function is_binary_file($file)
2897
  {
2898
    try {
2899
      $fp = fopen($file, 'rb');
2900
      $block = fread($fp, 512);
2901
      fclose($fp);
2902
    } catch (\Exception $e) {
2903
      $block = '';
2904
    }
2905
2906
    return self::is_binary($block);
2907
  }
2908
2909
  /**
2910
   * Checks if the given string is equal to any "Byte Order Mark".
2911
   *
2912
   * WARNING: Use "UTF8::string_has_bom()" if you will check BOM in a string.
2913
   *
2914
   * @param string $str <p>The input string.</p>
2915
   *
2916
   * @return bool <p><strong>true</strong> if the $utf8_chr is Byte Order Mark, <strong>false</strong> otherwise.</p>
2917
   */
2918 1
  public static function is_bom($str)
2919
  {
2920 1
    foreach (self::$BOM as $bomString => $bomByteLength) {
2921 1
      if ($str === $bomString) {
2922 1
        return true;
2923
      }
2924 1
    }
2925
2926 1
    return false;
2927
  }
2928
2929
  /**
2930
   * Check if the string contains any html-tags <lall>.
2931
   *
2932
   * @param string $str <p>The input string.</p>
2933
   *
2934
   * @return boolean
2935
   */
2936 1
  public static function is_html($str)
2937
  {
2938 1
    $str = (string)$str;
2939
2940 1
    if (!isset($str[0])) {
2941 1
      return false;
2942
    }
2943
2944
    // init
2945 1
    $matches = array();
2946
2947 1
    preg_match("/<\/?\w+(?:(?:\s+\w+(?:\s*=\s*(?:\".*?\"|'.*?'|[^'\">\s]+))?)*+\s*|\s*)\/?>/", $str, $matches);
2948
2949 1
    if (count($matches) === 0) {
2950 1
      return false;
2951
    }
2952
2953 1
    return true;
2954
  }
2955
2956
  /**
2957
   * Try to check if "$str" is an json-string.
2958
   *
2959
   * @param string $str <p>The input string.</p>
2960
   *
2961
   * @return bool
2962
   */
2963 1
  public static function is_json($str)
2964
  {
2965 1
    $str = (string)$str;
2966
2967 1
    if (!isset($str[0])) {
2968
      return false;
2969
    }
2970
2971 1
    $json = self::json_decode($str);
2972
2973
    if (
2974
        (
2975 1
            is_object($json) === true
2976 1
            ||
2977 1
            is_array($json) === true
2978 1
        )
2979 1
        &&
2980 1
        json_last_error() === JSON_ERROR_NONE
2981 1
    ) {
2982 1
      return true;
2983
    }
2984
2985 1
    return false;
2986
  }
2987
2988
  /**
2989
   * Check if the string is UTF-16.
2990
   *
2991
   * @param string $str <p>The input string.</p>
2992
   *
2993
   * @return int|false <p>
2994
   *                   <strong>false</strong> if is't not UTF-16,<br>
2995
   *                   <strong>1</strong> for UTF-16LE,<br>
2996
   *                   <strong>2</strong> for UTF-16BE.
2997
   *                   </p>
2998
   */
2999 5 View Code Duplication
  public static function is_utf16($str)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
3000
  {
3001 5
    $str = self::remove_bom($str);
3002
3003 5
    if (self::is_binary($str) === true) {
3004
3005 5
      $maybeUTF16LE = 0;
3006 5
      $test = \mb_convert_encoding($str, 'UTF-8', 'UTF-16LE');
3007 5
      if ($test) {
3008 5
        $test2 = \mb_convert_encoding($test, 'UTF-16LE', 'UTF-8');
3009 5
        $test3 = \mb_convert_encoding($test2, 'UTF-8', 'UTF-16LE');
3010 5
        if ($test3 === $test) {
3011 5
          $strChars = self::count_chars($str, true);
3012 5
          foreach (self::count_chars($test3, true) as $test3char => $test3charEmpty) {
3013 5
            if (in_array($test3char, $strChars, true) === true) {
3014 2
              $maybeUTF16LE++;
3015 2
            }
3016 5
          }
3017 5
        }
3018 5
      }
3019
3020 5
      $maybeUTF16BE = 0;
3021 5
      $test = \mb_convert_encoding($str, 'UTF-8', 'UTF-16BE');
3022 5
      if ($test) {
3023 5
        $test2 = \mb_convert_encoding($test, 'UTF-16BE', 'UTF-8');
3024 5
        $test3 = \mb_convert_encoding($test2, 'UTF-8', 'UTF-16BE');
3025 5
        if ($test3 === $test) {
3026 5
          $strChars = self::count_chars($str, true);
3027 5
          foreach (self::count_chars($test3, true) as $test3char => $test3charEmpty) {
3028 5
            if (in_array($test3char, $strChars, true) === true) {
3029 4
              $maybeUTF16BE++;
3030 4
            }
3031 5
          }
3032 5
        }
3033 5
      }
3034
3035 5
      if ($maybeUTF16BE !== $maybeUTF16LE) {
3036 4
        if ($maybeUTF16LE > $maybeUTF16BE) {
3037 2
          return 1;
3038
        }
3039
3040 4
        return 2;
3041
      }
3042
3043 2
    }
3044
3045 2
    return false;
3046
  }
3047
3048
  /**
3049
   * Check if the string is UTF-32.
3050
   *
3051
   * @param string $str
3052
   *
3053
   * @return int|false <p>
3054
   *                   <strong>false</strong> if is't not UTF-32,<br>
3055
   *                   <strong>1</strong> for UTF-32LE,<br>
3056
   *                   <strong>2</strong> for UTF-32BE.
3057
   *                   </p>
3058
   */
3059 2 View Code Duplication
  public static function is_utf32($str)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
3060
  {
3061 2
    $str = self::remove_bom($str);
3062
3063 2
    if (self::is_binary($str) === true) {
3064
3065 2
      $maybeUTF32LE = 0;
3066 2
      $test = \mb_convert_encoding($str, 'UTF-8', 'UTF-32LE');
3067 2
      if ($test) {
3068 2
        $test2 = \mb_convert_encoding($test, 'UTF-32LE', 'UTF-8');
3069 2
        $test3 = \mb_convert_encoding($test2, 'UTF-8', 'UTF-32LE');
3070 2
        if ($test3 === $test) {
3071 2
          $strChars = self::count_chars($str, true);
3072 2
          foreach (self::count_chars($test3, true) as $test3char => $test3charEmpty) {
3073 2
            if (in_array($test3char, $strChars, true) === true) {
3074 1
              $maybeUTF32LE++;
3075 1
            }
3076 2
          }
3077 2
        }
3078 2
      }
3079
3080 2
      $maybeUTF32BE = 0;
3081 2
      $test = \mb_convert_encoding($str, 'UTF-8', 'UTF-32BE');
3082 2
      if ($test) {
3083 2
        $test2 = \mb_convert_encoding($test, 'UTF-32BE', 'UTF-8');
3084 2
        $test3 = \mb_convert_encoding($test2, 'UTF-8', 'UTF-32BE');
3085 2
        if ($test3 === $test) {
3086 2
          $strChars = self::count_chars($str, true);
3087 2
          foreach (self::count_chars($test3, true) as $test3char => $test3charEmpty) {
3088 2
            if (in_array($test3char, $strChars, true) === true) {
3089 1
              $maybeUTF32BE++;
3090 1
            }
3091 2
          }
3092 2
        }
3093 2
      }
3094
3095 2
      if ($maybeUTF32BE !== $maybeUTF32LE) {
3096 1
        if ($maybeUTF32LE > $maybeUTF32BE) {
3097 1
          return 1;
3098
        }
3099
3100 1
        return 2;
3101
      }
3102
3103 2
    }
3104
3105 2
    return false;
3106
  }
3107
3108
  /**
3109
   * Checks whether the passed string contains only byte sequences that appear valid UTF-8 characters.
3110
   *
3111
   * @see    http://hsivonen.iki.fi/php-utf8/
3112
   *
3113
   * @param string $str    <p>The string to be checked.</p>
3114
   * @param bool   $strict <p>Check also if the string is not UTF-16 or UTF-32.</p>
3115
   *
3116
   * @return bool
3117
   */
3118 60
  public static function is_utf8($str, $strict = false)
3119
  {
3120 60
    $str = (string)$str;
3121
3122 60
    if (!isset($str[0])) {
3123 3
      return true;
3124
    }
3125
3126 58
    if ($strict === true) {
3127 1
      if (self::is_utf16($str) !== false) {
3128 1
        return false;
3129
      }
3130
3131
      if (self::is_utf32($str) !== false) {
3132
        return false;
3133
      }
3134
    }
3135
3136 58
    if (self::pcre_utf8_support() !== true) {
3137
3138
      // If even just the first character can be matched, when the /u
3139
      // modifier is used, then it's valid UTF-8. If the UTF-8 is somehow
3140
      // invalid, nothing at all will match, even if the string contains
3141
      // some valid sequences
3142
      return (preg_match('/^.{1}/us', $str, $ar) === 1);
3143
    }
3144
3145 58
    $mState = 0; // cached expected number of octets after the current octet
3146
    // until the beginning of the next UTF8 character sequence
3147 58
    $mUcs4 = 0; // cached Unicode character
3148 58
    $mBytes = 1; // cached expected number of octets in the current sequence
3149
3150 58
    if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
3151
      self::checkForSupport();
3152
    }
3153
3154 58 View Code Duplication
    if (self::$SUPPORT['mbstring_func_overload'] === true) {
3155
      $len = \mb_strlen($str, '8BIT');
3156
    } else {
3157 58
      $len = strlen($str);
3158
    }
3159
3160
    /** @noinspection ForeachInvariantsInspection */
3161 58
    for ($i = 0; $i < $len; $i++) {
3162 58
      $in = ord($str[$i]);
3163 58
      if ($mState === 0) {
3164
        // When mState is zero we expect either a US-ASCII character or a
3165
        // multi-octet sequence.
3166 58
        if (0 === (0x80 & $in)) {
3167
          // US-ASCII, pass straight through.
3168 53
          $mBytes = 1;
3169 58 View Code Duplication
        } elseif (0xC0 === (0xE0 & $in)) {
3170
          // First octet of 2 octet sequence.
3171 48
          $mUcs4 = $in;
3172 48
          $mUcs4 = ($mUcs4 & 0x1F) << 6;
3173 48
          $mState = 1;
3174 48
          $mBytes = 2;
3175 55
        } elseif (0xE0 === (0xF0 & $in)) {
3176
          // First octet of 3 octet sequence.
3177 30
          $mUcs4 = $in;
3178 30
          $mUcs4 = ($mUcs4 & 0x0F) << 12;
3179 30
          $mState = 2;
3180 30
          $mBytes = 3;
3181 46 View Code Duplication
        } elseif (0xF0 === (0xF8 & $in)) {
3182
          // First octet of 4 octet sequence.
3183 12
          $mUcs4 = $in;
3184 12
          $mUcs4 = ($mUcs4 & 0x07) << 18;
3185 12
          $mState = 3;
3186 12
          $mBytes = 4;
3187 22
        } elseif (0xF8 === (0xFC & $in)) {
3188
          /* First octet of 5 octet sequence.
3189
          *
3190
          * This is illegal because the encoded codepoint must be either
3191
          * (a) not the shortest form or
3192
          * (b) outside the Unicode range of 0-0x10FFFF.
3193
          * Rather than trying to resynchronize, we will carry on until the end
3194
          * of the sequence and let the later error handling code catch it.
3195
          */
3196 4
          $mUcs4 = $in;
3197 4
          $mUcs4 = ($mUcs4 & 0x03) << 24;
3198 4
          $mState = 4;
3199 4
          $mBytes = 5;
3200 11 View Code Duplication
        } elseif (0xFC === (0xFE & $in)) {
3201
          // First octet of 6 octet sequence, see comments for 5 octet sequence.
3202 4
          $mUcs4 = $in;
3203 4
          $mUcs4 = ($mUcs4 & 1) << 30;
3204 4
          $mState = 5;
3205 4
          $mBytes = 6;
3206 4
        } else {
3207
          /* Current octet is neither in the US-ASCII range nor a legal first
3208
           * octet of a multi-octet sequence.
3209
           */
3210 5
          return false;
3211
        }
3212 58
      } else {
3213
        // When mState is non-zero, we expect a continuation of the multi-octet
3214
        // sequence
3215 53
        if (0x80 === (0xC0 & $in)) {
3216
          // Legal continuation.
3217 49
          $shift = ($mState - 1) * 6;
3218 49
          $tmp = $in;
3219 49
          $tmp = ($tmp & 0x0000003F) << $shift;
3220 49
          $mUcs4 |= $tmp;
3221
          /**
3222
           * End of the multi-octet sequence. mUcs4 now contains the final
3223
           * Unicode code point to be output
3224
           */
3225 49
          if (0 === --$mState) {
3226
            /*
3227
            * Check for illegal sequences and code points.
3228
            */
3229
            // From Unicode 3.1, non-shortest form is illegal
3230
            if (
3231 49
                (2 === $mBytes && $mUcs4 < 0x0080) ||
3232 49
                (3 === $mBytes && $mUcs4 < 0x0800) ||
3233 49
                (4 === $mBytes && $mUcs4 < 0x10000) ||
3234 49
                (4 < $mBytes) ||
3235
                // From Unicode 3.2, surrogate characters are illegal.
3236 49
                (($mUcs4 & 0xFFFFF800) === 0xD800) ||
3237
                // Code points outside the Unicode range are illegal.
3238 49
                ($mUcs4 > 0x10FFFF)
3239 49
            ) {
3240 7
              return false;
3241
            }
3242
            // initialize UTF8 cache
3243 49
            $mState = 0;
3244 49
            $mUcs4 = 0;
3245 49
            $mBytes = 1;
3246 49
          }
3247 49
        } else {
3248
          /**
3249
           *((0xC0 & (*in) != 0x80) && (mState != 0))
3250
           * Incomplete multi-octet sequence.
3251
           */
3252 26
          return false;
3253
        }
3254
      }
3255 58
    }
3256
3257 28
    return true;
3258
  }
3259
3260
  /**
3261
   * (PHP 5 &gt;= 5.2.0, PECL json &gt;= 1.2.0)<br/>
3262
   * Decodes a JSON string
3263
   *
3264
   * @link http://php.net/manual/en/function.json-decode.php
3265
   *
3266
   * @param string $json    <p>
3267
   *                        The <i>json</i> string being decoded.
3268
   *                        </p>
3269
   *                        <p>
3270
   *                        This function only works with UTF-8 encoded strings.
3271
   *                        </p>
3272
   *                        <p>PHP implements a superset of
3273
   *                        JSON - it will also encode and decode scalar types and <b>NULL</b>. The JSON standard
3274
   *                        only supports these values when they are nested inside an array or an object.
3275
   *                        </p>
3276
   * @param bool   $assoc   [optional] <p>
3277
   *                        When <b>TRUE</b>, returned objects will be converted into
3278
   *                        associative arrays.
3279
   *                        </p>
3280
   * @param int    $depth   [optional] <p>
3281
   *                        User specified recursion depth.
3282
   *                        </p>
3283
   * @param int    $options [optional] <p>
3284
   *                        Bitmask of JSON decode options. Currently only
3285
   *                        <b>JSON_BIGINT_AS_STRING</b>
3286
   *                        is supported (default is to cast large integers as floats)
3287
   *                        </p>
3288
   *
3289
   * @return mixed the value encoded in <i>json</i> in appropriate
3290
   * PHP type. Values true, false and
3291
   * null (case-insensitive) are returned as <b>TRUE</b>, <b>FALSE</b>
3292
   * and <b>NULL</b> respectively. <b>NULL</b> is returned if the
3293
   * <i>json</i> cannot be decoded or if the encoded
3294
   * data is deeper than the recursion limit.
3295
   */
3296 2 View Code Duplication
  public static function json_decode($json, $assoc = false, $depth = 512, $options = 0)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
3297
  {
3298 2
    $json = (string)self::filter($json);
3299
3300 2
    if (Bootup::is_php('5.4') === true) {
3301 2
      $json = json_decode($json, $assoc, $depth, $options);
3302 2
    } else {
3303
      $json = json_decode($json, $assoc, $depth);
3304
    }
3305
3306 2
    return $json;
3307
  }
3308
3309
  /**
3310
   * (PHP 5 &gt;= 5.2.0, PECL json &gt;= 1.2.0)<br/>
3311
   * Returns the JSON representation of a value.
3312
   *
3313
   * @link http://php.net/manual/en/function.json-encode.php
3314
   *
3315
   * @param mixed $value   <p>
3316
   *                       The <i>value</i> being encoded. Can be any type except
3317
   *                       a resource.
3318
   *                       </p>
3319
   *                       <p>
3320
   *                       All string data must be UTF-8 encoded.
3321
   *                       </p>
3322
   *                       <p>PHP implements a superset of
3323
   *                       JSON - it will also encode and decode scalar types and <b>NULL</b>. The JSON standard
3324
   *                       only supports these values when they are nested inside an array or an object.
3325
   *                       </p>
3326
   * @param int   $options [optional] <p>
3327
   *                       Bitmask consisting of <b>JSON_HEX_QUOT</b>,
3328
   *                       <b>JSON_HEX_TAG</b>,
3329
   *                       <b>JSON_HEX_AMP</b>,
3330
   *                       <b>JSON_HEX_APOS</b>,
3331
   *                       <b>JSON_NUMERIC_CHECK</b>,
3332
   *                       <b>JSON_PRETTY_PRINT</b>,
3333
   *                       <b>JSON_UNESCAPED_SLASHES</b>,
3334
   *                       <b>JSON_FORCE_OBJECT</b>,
3335
   *                       <b>JSON_UNESCAPED_UNICODE</b>. The behaviour of these
3336
   *                       constants is described on
3337
   *                       the JSON constants page.
3338
   *                       </p>
3339
   * @param int   $depth   [optional] <p>
3340
   *                       Set the maximum depth. Must be greater than zero.
3341
   *                       </p>
3342
   *
3343
   * @return string a JSON encoded string on success or <b>FALSE</b> on failure.
3344
   */
3345 2 View Code Duplication
  public static function json_encode($value, $options = 0, $depth = 512)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
3346
  {
3347 2
    $value = self::filter($value);
3348
3349 2
    if (Bootup::is_php('5.5') === true) {
3350
      $json = json_encode($value, $options, $depth);
3351
    } else {
3352 2
      $json = json_encode($value, $options);
3353
    }
3354
3355 2
    return $json;
3356
  }
3357
3358
  /**
3359
   * Makes string's first char lowercase.
3360
   *
3361
   * @param string  $str       <p>The input string</p>
3362
   * @param string  $encoding  [optional] <p>Set the charset.</p>
3363
   * @param boolean $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
3364
   *
3365
   * @return string <p>The resulting string</p>
3366
   */
3367 7
  public static function lcfirst($str, $encoding = 'UTF-8', $cleanUtf8 = false)
3368
  {
3369 7
    $strPartTwo = self::substr($str, 1, null, $encoding, $cleanUtf8);
3370 7
    if ($strPartTwo === false) {
3371
      $strPartTwo = '';
3372
    }
3373
3374 7
    $strPartOne = self::strtolower(
3375 7
        (string)self::substr($str, 0, 1, $encoding, $cleanUtf8),
3376 7
        $encoding,
3377
        $cleanUtf8
3378 7
    );
3379
3380 7
    return $strPartOne . $strPartTwo;
3381
  }
3382
3383
  /**
3384
   * alias for "UTF8::lcfirst()"
3385
   *
3386
   * @see UTF8::lcfirst()
3387
   *
3388
   * @param string  $word
3389
   * @param string  $encoding
3390
   * @param boolean $cleanUtf8
3391
   *
3392
   * @return string
3393
   */
3394 1
  public static function lcword($word, $encoding = 'UTF-8', $cleanUtf8 = false)
3395
  {
3396 1
    return self::lcfirst($word, $encoding, $cleanUtf8);
3397
  }
3398
3399
  /**
3400
   * Lowercase for all words in the string.
3401
   *
3402
   * @param string   $str        <p>The input string.</p>
3403
   * @param string[] $exceptions [optional] <p>Exclusion for some words.</p>
3404
   * @param string   $charlist   [optional] <p>Additional chars that contains to words and do not start a new word.</p>
3405
   * @param string   $encoding   [optional] <p>Set the charset.</p>
3406
   * @param boolean  $cleanUtf8  [optional] <p>Remove non UTF-8 chars from the string.</p>
3407
   *
3408
   * @return string
3409
   */
3410 1
  public static function lcwords($str, $exceptions = array(), $charlist = '', $encoding = 'UTF-8', $cleanUtf8 = false)
3411
  {
3412 1
    if (!$str) {
3413 1
      return '';
3414
    }
3415
3416 1
    $words = self::str_to_words($str, $charlist);
3417 1
    $newWords = array();
3418
3419 1
    if (count($exceptions) > 0) {
3420 1
      $useExceptions = true;
3421 1
    } else {
3422 1
      $useExceptions = false;
3423
    }
3424
3425 1 View Code Duplication
    foreach ($words as $word) {
3426
3427 1
      if (!$word) {
3428 1
        continue;
3429
      }
3430
3431
      if (
3432
          $useExceptions === false
3433 1
          ||
3434
          (
3435
              $useExceptions === true
3436 1
              &&
3437 1
              !in_array($word, $exceptions, true)
3438 1
          )
3439 1
      ) {
3440 1
        $word = self::lcfirst($word, $encoding, $cleanUtf8);
3441 1
      }
3442
3443 1
      $newWords[] = $word;
3444 1
    }
3445
3446 1
    return implode('', $newWords);
3447
  }
3448
3449
  /**
3450
   * Strip whitespace or other characters from beginning of a UTF-8 string.
3451
   *
3452
   * @param string $str   <p>The string to be trimmed</p>
3453
   * @param string $chars <p>Optional characters to be stripped</p>
3454
   *
3455
   * @return string <p>The string with unwanted characters stripped from the left.</p>
3456
   */
3457 24 View Code Duplication
  public static function ltrim($str = '', $chars = INF)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
3458
  {
3459 24
    $str = (string)$str;
3460
3461 24
    if (!isset($str[0])) {
3462 2
      return '';
3463
    }
3464
3465
    // Info: http://nadeausoftware.com/articles/2007/9/php_tip_how_strip_punctuation_characters_web_page#Unicodecharactercategories
3466 23
    if ($chars === INF || !$chars) {
3467 2
      return preg_replace('/^[\pZ\pC]+/u', '', $str);
3468
    }
3469
3470 23
    return preg_replace('/^' . self::rxClass($chars) . '+/u', '', $str);
3471
  }
3472
3473
  /**
3474
   * Returns the UTF-8 character with the maximum code point in the given data.
3475
   *
3476
   * @param mixed $arg <p>A UTF-8 encoded string or an array of such strings.</p>
3477
   *
3478
   * @return string <p>The character with the highest code point than others.</p>
3479
   */
3480 1 View Code Duplication
  public static function max($arg)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
3481
  {
3482 1
    if (is_array($arg) === true) {
3483 1
      $arg = implode('', $arg);
3484 1
    }
3485
3486 1
    return self::chr(max(self::codepoints($arg)));
3487
  }
3488
3489
  /**
3490
   * Calculates and returns the maximum number of bytes taken by any
3491
   * UTF-8 encoded character in the given string.
3492
   *
3493
   * @param string $str <p>The original Unicode string.</p>
3494
   *
3495
   * @return int <p>Max byte lengths of the given chars.</p>
3496
   */
3497 1
  public static function max_chr_width($str)
3498
  {
3499 1
    $bytes = self::chr_size_list($str);
3500 1
    if (count($bytes) > 0) {
3501 1
      return (int)max($bytes);
3502
    }
3503
3504 1
    return 0;
3505
  }
3506
3507
  /**
3508
   * Checks whether mbstring is available on the server.
3509
   *
3510
   * @return bool <p><strong>true</strong> if available, <strong>false</strong> otherwise.</p>
3511
   */
3512 15
  public static function mbstring_loaded()
3513
  {
3514 15
    $return = extension_loaded('mbstring') ? true : false;
3515
3516 15
    if ($return === true) {
3517 15
      \mb_internal_encoding('UTF-8');
3518 15
    }
3519
3520 15
    return $return;
3521
  }
3522
3523
  /**
3524
   * Returns the UTF-8 character with the minimum code point in the given data.
3525
   *
3526
   * @param mixed $arg <strong>A UTF-8 encoded string or an array of such strings.</strong>
3527
   *
3528
   * @return string <p>The character with the lowest code point than others.</p>
3529
   */
3530 1 View Code Duplication
  public static function min($arg)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
3531
  {
3532 1
    if (is_array($arg) === true) {
3533 1
      $arg = implode('', $arg);
3534 1
    }
3535
3536 1
    return self::chr(min(self::codepoints($arg)));
3537
  }
3538
3539
  /**
3540
   * alias for "UTF8::normalize_encoding()"
3541
   *
3542
   * @see UTF8::normalize_encoding()
3543
   *
3544
   * @param string $encoding
3545
   * @param mixed  $fallback
3546
   *
3547
   * @return string
3548
   *
3549
   * @deprecated <p>use "UTF8::normalize_encoding()"</p>
3550
   */
3551
  public static function normalizeEncoding($encoding, $fallback = false)
3552
  {
3553
    return self::normalize_encoding($encoding, $fallback);
3554
  }
3555
3556
  /**
3557
   * Normalize the encoding-"name" input.
3558
   *
3559
   * @param string $encoding <p>e.g.: ISO, UTF8, WINDOWS-1251 etc.</p>
3560
   * @param mixed  $fallback <p>e.g.: UTF-8</p>
3561
   *
3562
   * @return string <p>e.g.: ISO-8859-1, UTF-8, WINDOWS-1251 etc.</p>
3563
   */
3564 77
  public static function normalize_encoding($encoding, $fallback = false)
3565
  {
3566 77
    static $STATIC_NORMALIZE_ENCODING_CACHE = array();
3567
3568
    // init
3569 77
    $encoding = trim((string)$encoding);
3570
3571
    // fallback
3572 77
    if (!$encoding && $fallback) {
3573 2
      return $fallback;
3574
    }
3575 76
    if (!$encoding) {
3576 1
      return 'UTF-8';
3577
    }
3578
3579 76
    if ('UTF-8' === $encoding) {
3580 1
      return $encoding;
3581
    }
3582
3583 76
    if (in_array($encoding, self::$ICONV_ENCODING, true)) {
3584 6
      return $encoding;
3585
    }
3586
3587 75
    if (isset($STATIC_NORMALIZE_ENCODING_CACHE[$encoding])) {
3588 74
      return $STATIC_NORMALIZE_ENCODING_CACHE[$encoding];
3589
    }
3590
3591 5
    $encodingOrig = $encoding;
3592 5
    $encoding = strtoupper($encoding);
3593 5
    $encodingUpperHelper = preg_replace('/[^A-Z0-9\s]/', '', $encoding);
3594
3595
    $equivalences = array(
3596 5
        'ISO8859'     => 'ISO-8859-1',
3597 5
        'ISO88591'    => 'ISO-8859-1',
3598 5
        'ISO'         => 'ISO-8859-1',
3599 5
        'LATIN'       => 'ISO-8859-1',
3600 5
        'LATIN1'      => 'ISO-8859-1', // Western European
3601 5
        'ISO88592'    => 'ISO-8859-2',
3602 5
        'LATIN2'      => 'ISO-8859-2', // Central European
3603 5
        'ISO88593'    => 'ISO-8859-3',
3604 5
        'LATIN3'      => 'ISO-8859-3', // Southern European
3605 5
        'ISO88594'    => 'ISO-8859-4',
3606 5
        'LATIN4'      => 'ISO-8859-4', // Northern European
3607 5
        'ISO88595'    => 'ISO-8859-5',
3608 5
        'ISO88596'    => 'ISO-8859-6', // Greek
3609 5
        'ISO88597'    => 'ISO-8859-7',
3610 5
        'ISO88598'    => 'ISO-8859-8', // Hebrew
3611 5
        'ISO88599'    => 'ISO-8859-9',
3612 5
        'LATIN5'      => 'ISO-8859-9', // Turkish
3613 5
        'ISO885911'   => 'ISO-8859-11',
3614 5
        'TIS620'      => 'ISO-8859-11', // Thai
3615 5
        'ISO885910'   => 'ISO-8859-10',
3616 5
        'LATIN6'      => 'ISO-8859-10', // Nordic
3617 5
        'ISO885913'   => 'ISO-8859-13',
3618 5
        'LATIN7'      => 'ISO-8859-13', // Baltic
3619 5
        'ISO885914'   => 'ISO-8859-14',
3620 5
        'LATIN8'      => 'ISO-8859-14', // Celtic
3621 5
        'ISO885915'   => 'ISO-8859-15',
3622 5
        'LATIN9'      => 'ISO-8859-15', // Western European (with some extra chars e.g. €)
3623 5
        'ISO885916'   => 'ISO-8859-16',
3624 5
        'LATIN10'     => 'ISO-8859-16', // Southeast European
3625 5
        'CP1250'      => 'WINDOWS-1250',
3626 5
        'WIN1250'     => 'WINDOWS-1250',
3627 5
        'WINDOWS1250' => 'WINDOWS-1250',
3628 5
        'CP1251'      => 'WINDOWS-1251',
3629 5
        'WIN1251'     => 'WINDOWS-1251',
3630 5
        'WINDOWS1251' => 'WINDOWS-1251',
3631 5
        'CP1252'      => 'WINDOWS-1252',
3632 5
        'WIN1252'     => 'WINDOWS-1252',
3633 5
        'WINDOWS1252' => 'WINDOWS-1252',
3634 5
        'CP1253'      => 'WINDOWS-1253',
3635 5
        'WIN1253'     => 'WINDOWS-1253',
3636 5
        'WINDOWS1253' => 'WINDOWS-1253',
3637 5
        'CP1254'      => 'WINDOWS-1254',
3638 5
        'WIN1254'     => 'WINDOWS-1254',
3639 5
        'WINDOWS1254' => 'WINDOWS-1254',
3640 5
        'CP1255'      => 'WINDOWS-1255',
3641 5
        'WIN1255'     => 'WINDOWS-1255',
3642 5
        'WINDOWS1255' => 'WINDOWS-1255',
3643 5
        'CP1256'      => 'WINDOWS-1256',
3644 5
        'WIN1256'     => 'WINDOWS-1256',
3645 5
        'WINDOWS1256' => 'WINDOWS-1256',
3646 5
        'CP1257'      => 'WINDOWS-1257',
3647 5
        'WIN1257'     => 'WINDOWS-1257',
3648 5
        'WINDOWS1257' => 'WINDOWS-1257',
3649 5
        'CP1258'      => 'WINDOWS-1258',
3650 5
        'WIN1258'     => 'WINDOWS-1258',
3651 5
        'WINDOWS1258' => 'WINDOWS-1258',
3652 5
        'UTF16'       => 'UTF-16',
3653 5
        'UTF32'       => 'UTF-32',
3654 5
        'UTF8'        => 'UTF-8',
3655 5
        'UTF'         => 'UTF-8',
3656 5
        'UTF7'        => 'UTF-7',
3657 5
        '8BIT'        => 'CP850',
3658 5
        'BINARY'      => 'CP850',
3659 5
    );
3660
3661 5
    if (!empty($equivalences[$encodingUpperHelper])) {
3662 5
      $encoding = $equivalences[$encodingUpperHelper];
3663 5
    }
3664
3665 5
    $STATIC_NORMALIZE_ENCODING_CACHE[$encodingOrig] = $encoding;
3666
3667 5
    return $encoding;
3668
  }
3669
3670
  /**
3671
   * Normalize some MS Word special characters.
3672
   *
3673
   * @param string $str <p>The string to be normalized.</p>
3674
   *
3675
   * @return string
3676
   */
3677 16 View Code Duplication
  public static function normalize_msword($str)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
3678
  {
3679 16
    $str = (string)$str;
3680
3681 16
    if (!isset($str[0])) {
3682 1
      return '';
3683
    }
3684
3685 16
    static $UTF8_MSWORD_KEYS_CACHE = null;
3686 16
    static $UTF8_MSWORD_VALUES_CACHE = null;
3687
3688 16
    if ($UTF8_MSWORD_KEYS_CACHE === null) {
3689 1
      $UTF8_MSWORD_KEYS_CACHE = array_keys(self::$UTF8_MSWORD);
3690 1
      $UTF8_MSWORD_VALUES_CACHE = array_values(self::$UTF8_MSWORD);
3691 1
    }
3692
3693 16
    return str_replace($UTF8_MSWORD_KEYS_CACHE, $UTF8_MSWORD_VALUES_CACHE, $str);
3694
  }
3695
3696
  /**
3697
   * Normalize the whitespace.
3698
   *
3699
   * @param string $str                     <p>The string to be normalized.</p>
3700
   * @param bool   $keepNonBreakingSpace    [optional] <p>Set to true, to keep non-breaking-spaces.</p>
3701
   * @param bool   $keepBidiUnicodeControls [optional] <p>Set to true, to keep non-printable (for the web)
3702
   *                                        bidirectional text chars.</p>
3703
   *
3704
   * @return string
3705
   */
3706 37
  public static function normalize_whitespace($str, $keepNonBreakingSpace = false, $keepBidiUnicodeControls = false)
3707
  {
3708 37
    $str = (string)$str;
3709
3710 37
    if (!isset($str[0])) {
3711 4
      return '';
3712
    }
3713
3714 37
    static $WHITESPACE_CACHE = array();
3715 37
    $cacheKey = (int)$keepNonBreakingSpace;
3716
3717 37
    if (!isset($WHITESPACE_CACHE[$cacheKey])) {
3718
3719 2
      $WHITESPACE_CACHE[$cacheKey] = self::$WHITESPACE_TABLE;
3720
3721 2
      if ($keepNonBreakingSpace === true) {
3722
        /** @noinspection OffsetOperationsInspection */
3723 1
        unset($WHITESPACE_CACHE[$cacheKey]['NO-BREAK SPACE']);
3724 1
      }
3725
3726 2
      $WHITESPACE_CACHE[$cacheKey] = array_values($WHITESPACE_CACHE[$cacheKey]);
3727 2
    }
3728
3729 37
    if ($keepBidiUnicodeControls === false) {
3730 37
      static $BIDI_UNICODE_CONTROLS_CACHE = null;
3731
3732 37
      if ($BIDI_UNICODE_CONTROLS_CACHE === null) {
3733 1
        $BIDI_UNICODE_CONTROLS_CACHE = array_values(self::$BIDI_UNI_CODE_CONTROLS_TABLE);
3734 1
      }
3735
3736 37
      $str = str_replace($BIDI_UNICODE_CONTROLS_CACHE, '', $str);
3737 37
    }
3738
3739 37
    return str_replace($WHITESPACE_CACHE[$cacheKey], ' ', $str);
3740
  }
3741
3742
  /**
3743
   * Strip all whitespace characters. This includes tabs and newline
3744
   * characters, as well as multibyte whitespace such as the thin space
3745
   * and ideographic space.
3746
   *
3747
   * @param string $str
3748
   *
3749
   * @return string
3750
   */
3751 12
  public static function strip_whitespace($str)
3752
  {
3753 12
    $str = (string)$str;
3754
3755 12
    if (!isset($str[0])) {
3756 1
      return '';
3757
    }
3758
3759 11
    return (string)preg_replace('/[[:space:]]+/u', '', $str);
3760
  }
3761
3762
  /**
3763
   * Format a number with grouped thousands.
3764
   *
3765
   * @param float  $number
3766
   * @param int    $decimals
3767
   * @param string $dec_point
3768
   * @param string $thousands_sep
3769
   *
3770
   * @return string
3771
   *
3772
   * @deprecated <p>This has nothing to do with UTF-8.</p>
3773
   */
3774
  public static function number_format($number, $decimals = 0, $dec_point = '.', $thousands_sep = ',')
3775
  {
3776
    $thousands_sep = (string)$thousands_sep;
3777
    $dec_point = (string)$dec_point;
3778
    $number = (float)$number;
3779
3780
    if (
3781
        isset($thousands_sep[1], $dec_point[1])
3782
        &&
3783
        Bootup::is_php('5.4') === true
3784
    ) {
3785
      return str_replace(
3786
          array(
3787
              '.',
3788
              ',',
3789
          ),
3790
          array(
3791
              $dec_point,
3792
              $thousands_sep,
3793
          ),
3794
          number_format($number, $decimals, '.', ',')
3795
      );
3796
    }
3797
3798
    return number_format($number, $decimals, $dec_point, $thousands_sep);
3799
  }
3800
3801
  /**
3802
   * Calculates Unicode code point of the given UTF-8 encoded character.
3803
   *
3804
   * INFO: opposite to UTF8::chr()
3805
   *
3806
   * @param string      $chr      <p>The character of which to calculate code point.<p/>
3807
   * @param string|null $encoding [optional] <p>Default is UTF-8</p>
3808
   *
3809
   * @return int <p>
3810
   *             Unicode code point of the given character,<br>
3811
   *             0 on invalid UTF-8 byte sequence.
3812
   *             </p>
3813
   */
3814 23
  public static function ord($chr, $encoding = 'UTF-8')
3815
  {
3816
    // init
3817 23
    static $CHAR_CACHE = array();
3818 23
    $encoding = (string)$encoding;
3819
3820 23
    if ($encoding !== 'UTF-8') {
3821 1
      $encoding = self::normalize_encoding($encoding, 'UTF-8');
3822
3823
      // check again, if it's still not UTF-8
3824
      /** @noinspection NotOptimalIfConditionsInspection */
3825 1
      if ($encoding !== 'UTF-8') {
3826 1
        $chr = \mb_convert_encoding($chr, 'UTF-8', $encoding);
3827 1
      }
3828 1
    }
3829
3830 23
    if (isset($CHAR_CACHE[$chr]) === true) {
3831 23
      return $CHAR_CACHE[$chr];
3832
    }
3833
3834 10
    if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
3835
      self::checkForSupport();
3836
    }
3837
3838
    // save the original string
3839 10
    $chr_orig = $chr;
3840
3841 10
    if (self::$SUPPORT['intlChar'] === true) {
3842
      $code = \IntlChar::ord($chr);
3843
      if ($code) {
3844
        $CHAR_CACHE[$chr_orig] = $code;
3845
        return $code;
3846
      }
3847
    }
3848
3849
    /** @noinspection CallableParameterUseCaseInTypeContextInspection */
3850 10
    $chr = unpack('C*', (string)self::substr($chr, 0, 4, '8BIT'));
3851 10
    $code = $chr ? $chr[1] : 0;
3852
3853 10
    if (0xF0 <= $code && isset($chr[4])) {
3854 1
      return $CHAR_CACHE[$chr_orig] = (($code - 0xF0) << 18) + (($chr[2] - 0x80) << 12) + (($chr[3] - 0x80) << 6) + $chr[4] - 0x80;
3855
    }
3856
3857 10
    if (0xE0 <= $code && isset($chr[3])) {
3858 4
      return $CHAR_CACHE[$chr_orig] = (($code - 0xE0) << 12) + (($chr[2] - 0x80) << 6) + $chr[3] - 0x80;
3859
    }
3860
3861 10
    if (0xC0 <= $code && isset($chr[2])) {
3862 6
      return $CHAR_CACHE[$chr_orig] = (($code - 0xC0) << 6) + $chr[2] - 0x80;
3863
    }
3864
3865 10
    return $CHAR_CACHE[$chr_orig] = $code;
3866
  }
3867
3868
  /**
3869
   * Parses the string into an array (into the the second parameter).
3870
   *
3871
   * WARNING: Instead of "parse_str()" this method do not (re-)placing variables in the current scope,
3872
   *          if the second parameter is not set!
3873
   *
3874
   * @link http://php.net/manual/en/function.parse-str.php
3875
   *
3876
   * @param string  $str       <p>The input string.</p>
3877
   * @param array   $result    <p>The result will be returned into this reference parameter.</p>
3878
   * @param boolean $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
3879
   *
3880
   * @return bool <p>Will return <strong>false</strong> if php can't parse the string and we haven't any $result.</p>
3881
   */
3882 1
  public static function parse_str($str, &$result, $cleanUtf8 = false)
3883
  {
3884 1
    if ($cleanUtf8 === true) {
3885 1
      $str = self::clean($str);
3886 1
    }
3887
3888
    /** @noinspection PhpVoidFunctionResultUsedInspection */
3889 1
    $return = \mb_parse_str($str, $result);
3890 1
    if ($return === false || empty($result)) {
3891 1
      return false;
3892
    }
3893
3894 1
    return true;
3895
  }
3896
3897
  /**
3898
   * Checks if \u modifier is available that enables Unicode support in PCRE.
3899
   *
3900
   * @return bool <p><strong>true</strong> if support is available, <strong>false</strong> otherwise.</p>
3901
   */
3902 58
  public static function pcre_utf8_support()
3903
  {
3904
    /** @noinspection PhpUsageOfSilenceOperatorInspection */
3905 58
    return (bool)@preg_match('//u', '');
3906
  }
3907
3908
  /**
3909
   * Create an array containing a range of UTF-8 characters.
3910
   *
3911
   * @param mixed $var1 <p>Numeric or hexadecimal code points, or a UTF-8 character to start from.</p>
3912
   * @param mixed $var2 <p>Numeric or hexadecimal code points, or a UTF-8 character to end at.</p>
3913
   *
3914
   * @return array
3915
   */
3916 1
  public static function range($var1, $var2)
3917
  {
3918 1
    if (!$var1 || !$var2) {
3919 1
      return array();
3920
    }
3921
3922 1 View Code Duplication
    if (ctype_digit((string)$var1)) {
3923 1
      $start = (int)$var1;
3924 1
    } elseif (ctype_xdigit($var1)) {
3925
      $start = (int)self::hex_to_int($var1);
3926
    } else {
3927 1
      $start = self::ord($var1);
3928
    }
3929
3930 1
    if (!$start) {
3931
      return array();
3932
    }
3933
3934 1 View Code Duplication
    if (ctype_digit((string)$var2)) {
3935 1
      $end = (int)$var2;
3936 1
    } elseif (ctype_xdigit($var2)) {
3937
      $end = (int)self::hex_to_int($var2);
3938
    } else {
3939 1
      $end = self::ord($var2);
3940
    }
3941
3942 1
    if (!$end) {
3943
      return array();
3944
    }
3945
3946 1
    return array_map(
3947
        array(
3948 1
            '\\voku\\helper\\UTF8',
3949 1
            'chr',
3950 1
        ),
3951 1
        range($start, $end)
3952 1
    );
3953
  }
3954
3955
  /**
3956
   * Multi decode html entity & fix urlencoded-win1252-chars.
3957
   *
3958
   * e.g:
3959
   * 'test+test'                     => 'test+test'
3960
   * 'D&#252;sseldorf'               => 'Düsseldorf'
3961
   * 'D%FCsseldorf'                  => 'Düsseldorf'
3962
   * 'D&#xFC;sseldorf'               => 'Düsseldorf'
3963
   * 'D%26%23xFC%3Bsseldorf'         => 'Düsseldorf'
3964
   * 'Düsseldorf'                   => 'Düsseldorf'
3965
   * 'D%C3%BCsseldorf'               => 'Düsseldorf'
3966
   * 'D%C3%83%C2%BCsseldorf'         => 'Düsseldorf'
3967
   * 'D%25C3%2583%25C2%25BCsseldorf' => 'Düsseldorf'
3968
   *
3969
   * @param string $str          <p>The input string.</p>
3970
   * @param bool   $multi_decode <p>Decode as often as possible.</p>
3971
   *
3972
   * @return string
3973
   */
3974 2 View Code Duplication
  public static function rawurldecode($str, $multi_decode = true)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
3975
  {
3976 2
    $str = (string)$str;
3977
3978 2
    if (!isset($str[0])) {
3979 1
      return '';
3980
    }
3981
3982 2
    $pattern = '/%u([0-9a-f]{3,4})/i';
3983 2
    if (preg_match($pattern, $str)) {
3984 1
      $str = preg_replace($pattern, '&#x\\1;', rawurldecode($str));
3985 1
    }
3986
3987 2
    $flags = Bootup::is_php('5.4') === true ? ENT_QUOTES | ENT_HTML5 : ENT_QUOTES;
3988
3989
    do {
3990 2
      $str_compare = $str;
3991
3992 2
      $str = self::fix_simple_utf8(
3993 2
          rawurldecode(
3994 2
              self::html_entity_decode(
3995 2
                  self::to_utf8($str),
0 ignored issues
show
Bug introduced by
It seems like self::to_utf8($str) targeting voku\helper\UTF8::to_utf8() can also be of type array; however, voku\helper\UTF8::html_entity_decode() does only seem to accept string, maybe add an additional type check?

This check looks at variables that are passed out again to other methods.

If the outgoing method call has stricter type requirements than the method itself, an issue is raised.

An additional type check may prevent trouble.

Loading history...
3996
                  $flags
3997 2
              )
3998 2
          )
3999 2
      );
4000
4001 2
    } while ($multi_decode === true && $str_compare !== $str);
4002
4003 2
    return (string)$str;
4004
  }
4005
4006
  /**
4007
   * alias for "UTF8::remove_bom()"
4008
   *
4009
   * @see UTF8::remove_bom()
4010
   *
4011
   * @param string $str
4012
   *
4013
   * @return string
4014
   *
4015
   * @deprecated <p>use "UTF8::remove_bom()"</p>
4016
   */
4017
  public static function removeBOM($str)
4018
  {
4019
    return self::remove_bom($str);
4020
  }
4021
4022
  /**
4023
   * Remove the BOM from UTF-8 / UTF-16 / UTF-32 strings.
4024
   *
4025
   * @param string $str <p>The input string.</p>
4026
   *
4027
   * @return string <p>String without UTF-BOM</p>
4028
   */
4029 40
  public static function remove_bom($str)
4030
  {
4031 40
    $str = (string)$str;
4032
4033 40
    if (!isset($str[0])) {
4034 5
      return '';
4035
    }
4036
4037 40
    foreach (self::$BOM as $bomString => $bomByteLength) {
4038 40
      if (0 === self::strpos($str, $bomString, 0, '8BIT')) {
4039 5
        $strTmp = self::substr($str, $bomByteLength, null, '8BIT');
4040 5
        if ($strTmp === false) {
4041
          $strTmp = '';
4042
        }
4043 5
        $str = (string)$strTmp;
4044 5
      }
4045 40
    }
4046
4047 40
    return $str;
4048
  }
4049
4050
  /**
4051
   * Removes duplicate occurrences of a string in another string.
4052
   *
4053
   * @param string          $str  <p>The base string.</p>
4054
   * @param string|string[] $what <p>String to search for in the base string.</p>
4055
   *
4056
   * @return string <p>The result string with removed duplicates.</p>
4057
   */
4058 1
  public static function remove_duplicates($str, $what = ' ')
4059
  {
4060 1
    if (is_string($what) === true) {
4061 1
      $what = array($what);
4062 1
    }
4063
4064 1
    if (is_array($what) === true) {
4065
      /** @noinspection ForeachSourceInspection */
4066 1
      foreach ($what as $item) {
4067 1
        $str = preg_replace('/(' . preg_quote($item, '/') . ')+/', $item, $str);
4068 1
      }
4069 1
    }
4070
4071 1
    return $str;
4072
  }
4073
4074
  /**
4075
   * Remove invisible characters from a string.
4076
   *
4077
   * e.g.: This prevents sandwiching null characters between ascii characters, like Java\0script.
4078
   *
4079
   * copy&past from https://github.com/bcit-ci/CodeIgniter/blob/develop/system/core/Common.php
4080
   *
4081
   * @param string $str
4082
   * @param bool   $url_encoded
4083
   * @param string $replacement
4084
   *
4085
   * @return string
4086
   */
4087 57
  public static function remove_invisible_characters($str, $url_encoded = true, $replacement = '')
4088
  {
4089
    // init
4090 57
    $non_displayables = array();
4091
4092
    // every control character except newline (dec 10),
4093
    // carriage return (dec 13) and horizontal tab (dec 09)
4094 57
    if ($url_encoded) {
4095 57
      $non_displayables[] = '/%0[0-8bcef]/'; // url encoded 00-08, 11, 12, 14, 15
4096 57
      $non_displayables[] = '/%1[0-9a-f]/'; // url encoded 16-31
4097 57
    }
4098
4099 57
    $non_displayables[] = '/[\x00-\x08\x0B\x0C\x0E-\x1F\x7F]+/S'; // 00-08, 11, 12, 14-31, 127
4100
4101
    do {
4102 57
      $str = preg_replace($non_displayables, $replacement, $str, -1, $count);
4103 57
    } while ($count !== 0);
4104
4105 57
    return $str;
4106
  }
4107
4108
  /**
4109
   * Replace the diamond question mark (�) and invalid-UTF8 chars with the replacement.
4110
   *
4111
   * @param string $str                <p>The input string</p>
4112
   * @param string $replacementChar    <p>The replacement character.</p>
4113
   * @param bool   $processInvalidUtf8 <p>Convert invalid UTF-8 chars </p>
4114
   *
4115
   * @return string
4116
   */
4117 57
  public static function replace_diamond_question_mark($str, $replacementChar = '', $processInvalidUtf8 = true)
4118
  {
4119 57
    $str = (string)$str;
4120
4121 57
    if (!isset($str[0])) {
4122 4
      return '';
4123
    }
4124
4125 57
    if ($processInvalidUtf8 === true) {
4126 57
      $replacementCharHelper = $replacementChar;
4127 57
      if ($replacementChar === '') {
4128 57
        $replacementCharHelper = 'none';
4129 57
      }
4130
4131 57
      if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
4132
        self::checkForSupport();
4133
      }
4134
4135 57
      $save = \mb_substitute_character();
4136 57
      \mb_substitute_character($replacementCharHelper);
4137 57
      $str = \mb_convert_encoding($str, 'UTF-8', 'UTF-8');
4138 57
      \mb_substitute_character($save);
4139 57
    }
4140
4141 57
    return str_replace(
4142
        array(
4143 57
            "\xEF\xBF\xBD",
4144 57
            '�',
4145 57
        ),
4146
        array(
4147 57
            $replacementChar,
4148 57
            $replacementChar,
4149 57
        ),
4150
        $str
4151 57
    );
4152
  }
4153
4154
  /**
4155
   * Strip whitespace or other characters from end of a UTF-8 string.
4156
   *
4157
   * @param string $str   <p>The string to be trimmed.</p>
4158
   * @param string $chars <p>Optional characters to be stripped.</p>
4159
   *
4160
   * @return string <p>The string with unwanted characters stripped from the right.</p>
4161
   */
4162 23 View Code Duplication
  public static function rtrim($str = '', $chars = INF)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
4163
  {
4164 23
    $str = (string)$str;
4165
4166 23
    if (!isset($str[0])) {
4167 5
      return '';
4168
    }
4169
4170
    // Info: http://nadeausoftware.com/articles/2007/9/php_tip_how_strip_punctuation_characters_web_page#Unicodecharactercategories
4171 19
    if ($chars === INF || !$chars) {
4172 3
      return preg_replace('/[\pZ\pC]+$/u', '', $str);
4173
    }
4174
4175 18
    return preg_replace('/' . self::rxClass($chars) . '+$/u', '', $str);
4176
  }
4177
4178
  /**
4179
   * rxClass
4180
   *
4181
   * @param string $s
4182
   * @param string $class
4183
   *
4184
   * @return string
4185
   */
4186 60
  private static function rxClass($s, $class = '')
4187
  {
4188 60
    static $RX_CLASSS_CACHE = array();
4189
4190 60
    $cacheKey = $s . $class;
4191
4192 60
    if (isset($RX_CLASSS_CACHE[$cacheKey])) {
4193 48
      return $RX_CLASSS_CACHE[$cacheKey];
4194
    }
4195
4196
    /** @noinspection CallableParameterUseCaseInTypeContextInspection */
4197 19
    $class = array($class);
4198
4199
    /** @noinspection SuspiciousLoopInspection */
4200 19
    foreach (self::str_split($s) as $s) {
4201 18
      if ('-' === $s) {
4202
        $class[0] = '-' . $class[0];
4203 18
      } elseif (!isset($s[2])) {
4204 18
        $class[0] .= preg_quote($s, '/');
4205 18
      } elseif (1 === self::strlen($s)) {
4206 2
        $class[0] .= $s;
4207 2
      } else {
4208
        $class[] = $s;
4209
      }
4210 19
    }
4211
4212 19
    if ($class[0]) {
4213 19
      $class[0] = '[' . $class[0] . ']';
4214 19
    }
4215
4216 19
    if (1 === count($class)) {
4217 19
      $return = $class[0];
4218 19
    } else {
4219
      $return = '(?:' . implode('|', $class) . ')';
4220
    }
4221
4222 19
    $RX_CLASSS_CACHE[$cacheKey] = $return;
4223
4224 19
    return $return;
4225
  }
4226
4227
  /**
4228
   * WARNING: Print native UTF-8 support (libs), e.g. for debugging.
4229
   */
4230
  public static function showSupport()
4231
  {
4232
    if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
4233
      self::checkForSupport();
4234
    }
4235
4236
    foreach (self::$SUPPORT as $utf8Support) {
4237
      echo $utf8Support . "\n<br>";
4238
    }
4239
  }
4240
4241
  /**
4242
   * Converts a UTF-8 character to HTML Numbered Entity like "&#123;".
4243
   *
4244
   * @param string $char           <p>The Unicode character to be encoded as numbered entity.</p>
4245
   * @param bool   $keepAsciiChars <p>Set to <strong>true</strong> to keep ASCII chars.</>
4246
   * @param string $encoding       [optional] <p>Default is UTF-8</p>
4247
   *
4248
   * @return string <p>The HTML numbered entity.</p>
4249
   */
4250 1
  public static function single_chr_html_encode($char, $keepAsciiChars = false, $encoding = 'UTF-8')
4251
  {
4252 1
    $char = (string)$char;
4253
4254 1
    if (!isset($char[0])) {
4255 1
      return '';
4256
    }
4257
4258
    if (
4259
        $keepAsciiChars === true
4260 1
        &&
4261 1
        self::is_ascii($char) === true
4262 1
    ) {
4263 1
      return $char;
4264
    }
4265
4266 1
    if ($encoding !== 'UTF-8') {
4267
      $encoding = self::normalize_encoding($encoding, 'UTF-8');
4268
    }
4269
4270 1
    return '&#' . self::ord($char, $encoding) . ';';
4271
  }
4272
4273
  /**
4274
   * Convert a string to an array of Unicode characters.
4275
   *
4276
   * @param string  $str       <p>The string to split into array.</p>
4277
   * @param int     $length    [optional] <p>Max character length of each array element.</p>
4278
   * @param boolean $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
4279
   *
4280
   * @return string[] <p>An array containing chunks of the string.</p>
4281
   */
4282 39
  public static function split($str, $length = 1, $cleanUtf8 = false)
4283
  {
4284 39
    $str = (string)$str;
4285
4286 39
    if (!isset($str[0])) {
4287 3
      return array();
4288
    }
4289
4290
    // init
4291 38
    $ret = array();
4292
4293 38
    if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
4294
      self::checkForSupport();
4295
    }
4296
4297 38
    if ($cleanUtf8 === true) {
4298 7
      $str = self::clean($str);
4299 7
    }
4300
4301 38
    if (self::$SUPPORT['pcre_utf8'] === true) {
4302
4303 38
      preg_match_all('/./us', $str, $retArray);
4304 38
      if (isset($retArray[0])) {
4305 38
        $ret = $retArray[0];
4306 38
      }
4307 38
      unset($retArray);
4308
4309 38
    } else {
4310
4311
      // fallback
4312
4313
      if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
4314
        self::checkForSupport();
4315
      }
4316
4317 View Code Duplication
      if (self::$SUPPORT['mbstring_func_overload'] === true) {
4318
        $len = \mb_strlen($str, '8BIT');
4319
      } else {
4320
        $len = strlen($str);
4321
      }
4322
4323
      /** @noinspection ForeachInvariantsInspection */
4324
      for ($i = 0; $i < $len; $i++) {
4325
4326
        if (($str[$i] & "\x80") === "\x00") {
4327
4328
          $ret[] = $str[$i];
4329
4330
        } elseif (
4331
            isset($str[$i + 1])
4332
            &&
4333
            ($str[$i] & "\xE0") === "\xC0"
4334
        ) {
4335
4336
          if (($str[$i + 1] & "\xC0") === "\x80") {
4337
            $ret[] = $str[$i] . $str[$i + 1];
4338
4339
            $i++;
4340
          }
4341
4342 View Code Duplication
        } elseif (
4343
            isset($str[$i + 2])
4344
            &&
4345
            ($str[$i] & "\xF0") === "\xE0"
4346
        ) {
4347
4348
          if (
4349
              ($str[$i + 1] & "\xC0") === "\x80"
4350
              &&
4351
              ($str[$i + 2] & "\xC0") === "\x80"
4352
          ) {
4353
            $ret[] = $str[$i] . $str[$i + 1] . $str[$i + 2];
4354
4355
            $i += 2;
4356
          }
4357
4358
        } elseif (
4359
            isset($str[$i + 3])
4360
            &&
4361
            ($str[$i] & "\xF8") === "\xF0"
4362
        ) {
4363
4364 View Code Duplication
          if (
4365
              ($str[$i + 1] & "\xC0") === "\x80"
4366
              &&
4367
              ($str[$i + 2] & "\xC0") === "\x80"
4368
              &&
4369
              ($str[$i + 3] & "\xC0") === "\x80"
4370
          ) {
4371
            $ret[] = $str[$i] . $str[$i + 1] . $str[$i + 2] . $str[$i + 3];
4372
4373
            $i += 3;
4374
          }
4375
4376
        }
4377
      }
4378
    }
4379
4380 38
    if ($length > 1) {
4381 5
      $ret = array_chunk($ret, $length);
4382
4383 5
      return array_map(
4384
          function ($item) {
4385 5
            return implode('', $item);
4386 5
          }, $ret
4387 5
      );
4388
    }
4389
4390
    /** @noinspection OffsetOperationsInspection */
4391 34
    if (isset($ret[0]) && $ret[0] === '') {
4392
      return array();
4393
    }
4394
4395 34
    return $ret;
4396
  }
4397
4398
  /**
4399
   * Optimized "\mb_detect_encoding()"-function -> with support for UTF-16 and UTF-32.
4400
   *
4401
   * @param string $str <p>The input string.</p>
4402
   *
4403
   * @return false|string <p>
4404
   *                      The detected string-encoding e.g. UTF-8 or UTF-16BE,<br>
4405
   *                      otherwise it will return false.
4406
   *                      </p>
4407
   */
4408 13
  public static function str_detect_encoding($str)
4409
  {
4410
    //
4411
    // 1.) check binary strings (010001001...) like UTF-16 / UTF-32
4412
    //
4413
4414 13
    if (self::is_binary($str) === true) {
4415
4416 3
      if (self::is_utf16($str) === 1) {
4417 1
        return 'UTF-16LE';
4418
      }
4419
4420 3
      if (self::is_utf16($str) === 2) {
4421 2
        return 'UTF-16BE';
4422
      }
4423
4424 1
      if (self::is_utf32($str) === 1) {
4425
        return 'UTF-32LE';
4426
      }
4427
4428 1
      if (self::is_utf32($str) === 2) {
4429
        return 'UTF-32BE';
4430
      }
4431
4432 1
    }
4433
4434
    //
4435
    // 2.) simple check for ASCII chars
4436
    //
4437
4438 12
    if (self::is_ascii($str) === true) {
4439 4
      return 'ASCII';
4440
    }
4441
4442
    //
4443
    // 3.) simple check for UTF-8 chars
4444
    //
4445
4446 12
    if (self::is_utf8($str) === true) {
4447 10
      return 'UTF-8';
4448
    }
4449
4450
    //
4451
    // 4.) check via "\mb_detect_encoding()"
4452
    //
4453
    // INFO: UTF-16, UTF-32, UCS2 and UCS4, encoding detection will fail always with "\mb_detect_encoding()"
4454
4455
    $detectOrder = array(
4456 6
        'ISO-8859-1',
4457 6
        'ISO-8859-2',
4458 6
        'ISO-8859-3',
4459 6
        'ISO-8859-4',
4460 6
        'ISO-8859-5',
4461 6
        'ISO-8859-6',
4462 6
        'ISO-8859-7',
4463 6
        'ISO-8859-8',
4464 6
        'ISO-8859-9',
4465 6
        'ISO-8859-10',
4466 6
        'ISO-8859-13',
4467 6
        'ISO-8859-14',
4468 6
        'ISO-8859-15',
4469 6
        'ISO-8859-16',
4470 6
        'WINDOWS-1251',
4471 6
        'WINDOWS-1252',
4472 6
        'WINDOWS-1254',
4473 6
        'ISO-2022-JP',
4474 6
        'JIS',
4475 6
        'EUC-JP',
4476 6
    );
4477
4478 6
    $encoding = \mb_detect_encoding($str, $detectOrder, true);
4479 6
    if ($encoding) {
4480 6
      return $encoding;
4481
    }
4482
4483
    //
4484
    // 5.) check via "iconv()"
4485
    //
4486
4487
    $md5 = md5($str);
4488
    foreach (self::$ICONV_ENCODING as $encodingTmp) {
4489
      # INFO: //IGNORE and //TRANSLIT still throw notice
4490
      /** @noinspection PhpUsageOfSilenceOperatorInspection */
4491
      if (md5(@\iconv($encodingTmp, $encodingTmp . '//IGNORE', $str)) === $md5) {
4492
        return $encodingTmp;
4493
      }
4494
    }
4495
4496
    return false;
4497
  }
4498
4499
  /**
4500
   * Check if the string ends with the given substring.
4501
   *
4502
   * @param string $haystack <p>The string to search in.</p>
4503
   * @param string $needle   <p>The substring to search for.</p>
4504
   *
4505
   * @return bool
4506
   */
4507 2
  public static function str_ends_with($haystack, $needle)
4508
  {
4509 2
    $haystack = (string)$haystack;
4510 2
    $needle = (string)$needle;
4511
4512 2
    if (!isset($haystack[0], $needle[0])) {
4513 1
      return false;
4514
    }
4515
4516 2
    $haystackSub = self::substr($haystack, -self::strlen($needle));
4517 2
    if ($haystackSub === false) {
4518
      return false;
4519
    }
4520
4521 2
    if ($needle === $haystackSub) {
4522 2
      return true;
4523
    }
4524
4525 2
    return false;
4526
  }
4527
4528
  /**
4529
   * Check if the string ends with the given substring, case insensitive.
4530
   *
4531
   * @param string $haystack <p>The string to search in.</p>
4532
   * @param string $needle   <p>The substring to search for.</p>
4533
   *
4534
   * @return bool
4535
   */
4536 2 View Code Duplication
  public static function str_iends_with($haystack, $needle)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
4537
  {
4538 2
    $haystack = (string)$haystack;
4539 2
    $needle = (string)$needle;
4540
4541 2
    if (!isset($haystack[0], $needle[0])) {
4542 1
      return false;
4543
    }
4544
4545 2
    if (self::strcasecmp(self::substr($haystack, -self::strlen($needle)), $needle) === 0) {
0 ignored issues
show
Security Bug introduced by
It seems like self::substr($haystack, -self::strlen($needle)) targeting voku\helper\UTF8::substr() can also be of type false; however, voku\helper\UTF8::strcasecmp() does only seem to accept string, did you maybe forget to handle an error condition?
Loading history...
4546 2
      return true;
4547
    }
4548
4549 2
    return false;
4550
  }
4551
4552
  /**
4553
   * Case-insensitive and UTF-8 safe version of <function>str_replace</function>.
4554
   *
4555
   * @link  http://php.net/manual/en/function.str-ireplace.php
4556
   *
4557
   * @param mixed $search  <p>
4558
   *                       Every replacement with search array is
4559
   *                       performed on the result of previous replacement.
4560
   *                       </p>
4561
   * @param mixed $replace <p>
4562
   *                       </p>
4563
   * @param mixed $subject <p>
4564
   *                       If subject is an array, then the search and
4565
   *                       replace is performed with every entry of
4566
   *                       subject, and the return value is an array as
4567
   *                       well.
4568
   *                       </p>
4569
   * @param int   $count   [optional] <p>
4570
   *                       The number of matched and replaced needles will
4571
   *                       be returned in count which is passed by
4572
   *                       reference.
4573
   *                       </p>
4574
   *
4575
   * @return mixed <p>A string or an array of replacements.</p>
4576
   */
4577 26
  public static function str_ireplace($search, $replace, $subject, &$count = null)
4578
  {
4579 26
    $search = (array)$search;
4580
4581
    /** @noinspection AlterInForeachInspection */
4582 26
    foreach ($search as &$s) {
4583 26
      if ('' === $s .= '') {
4584 2
        $s = '/^(?<=.)$/';
4585 2
      } else {
4586 24
        $s = '/' . preg_quote($s, '/') . '/ui';
4587
      }
4588 26
    }
4589
4590 26
    $subject = preg_replace($search, $replace, $subject, -1, $replace);
4591 26
    $count = $replace; // used as reference parameter
4592
4593 26
    return $subject;
4594
  }
4595
4596
  /**
4597
   * Check if the string starts with the given substring, case insensitive.
4598
   *
4599
   * @param string $haystack <p>The string to search in.</p>
4600
   * @param string $needle   <p>The substring to search for.</p>
4601
   *
4602
   * @return bool
4603
   */
4604 2 View Code Duplication
  public static function str_istarts_with($haystack, $needle)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
4605
  {
4606 2
    $haystack = (string)$haystack;
4607 2
    $needle = (string)$needle;
4608
4609 2
    if (!isset($haystack[0], $needle[0])) {
4610 1
      return false;
4611
    }
4612
4613 2
    if (self::stripos($haystack, $needle) === 0) {
4614 2
      return true;
4615
    }
4616
4617 2
    return false;
4618
  }
4619
4620
  /**
4621
   * Limit the number of characters in a string, but also after the next word.
4622
   *
4623
   * @param string $str
4624
   * @param int    $length
4625
   * @param string $strAddOn
4626
   *
4627
   * @return string
4628
   */
4629 1
  public static function str_limit_after_word($str, $length = 100, $strAddOn = '...')
4630
  {
4631 1
    $str = (string)$str;
4632
4633 1
    if (!isset($str[0])) {
4634 1
      return '';
4635
    }
4636
4637 1
    $length = (int)$length;
4638
4639 1
    if (self::strlen($str) <= $length) {
4640 1
      return $str;
4641
    }
4642
4643 1
    if (self::substr($str, $length - 1, 1) === ' ') {
4644 1
      return (string)self::substr($str, 0, $length - 1) . $strAddOn;
4645
    }
4646
4647 1
    $str = (string)self::substr($str, 0, $length);
4648 1
    $array = explode(' ', $str);
4649 1
    array_pop($array);
4650 1
    $new_str = implode(' ', $array);
4651
4652 1
    if ($new_str === '') {
4653 1
      $str = (string)self::substr($str, 0, $length - 1) . $strAddOn;
4654 1
    } else {
4655 1
      $str = $new_str . $strAddOn;
4656
    }
4657
4658 1
    return $str;
4659
  }
4660
4661
  /**
4662
   * Pad a UTF-8 string to given length with another string.
4663
   *
4664
   * @param string $str        <p>The input string.</p>
4665
   * @param int    $pad_length <p>The length of return string.</p>
4666
   * @param string $pad_string [optional] <p>String to use for padding the input string.</p>
4667
   * @param int    $pad_type   [optional] <p>
4668
   *                           Can be <strong>STR_PAD_RIGHT</strong> (default),
4669
   *                           <strong>STR_PAD_LEFT</strong> or <strong>STR_PAD_BOTH</strong>
4670
   *                           </p>
4671
   *
4672
   * @return string <strong>Returns the padded string</strong>
4673
   */
4674 2
  public static function str_pad($str, $pad_length, $pad_string = ' ', $pad_type = STR_PAD_RIGHT)
4675
  {
4676 2
    $str_length = self::strlen($str);
4677
4678
    if (
4679 2
        is_int($pad_length) === true
4680 2
        &&
4681
        $pad_length > 0
4682 2
        &&
4683
        $pad_length >= $str_length
4684 2
    ) {
4685 2
      $ps_length = self::strlen($pad_string);
4686
4687 2
      $diff = $pad_length - $str_length;
4688
4689
      switch ($pad_type) {
4690 2 View Code Duplication
        case STR_PAD_LEFT:
4691 2
          $pre = str_repeat($pad_string, (int)ceil($diff / $ps_length));
4692 2
          $pre = (string)self::substr($pre, 0, $diff);
4693 2
          $post = '';
4694 2
          break;
4695
4696 2
        case STR_PAD_BOTH:
4697 2
          $pre = str_repeat($pad_string, (int)ceil($diff / $ps_length / 2));
4698 2
          $pre = (string)self::substr($pre, 0, (int)$diff / 2);
4699 2
          $post = str_repeat($pad_string, (int)ceil($diff / $ps_length / 2));
4700 2
          $post = (string)self::substr($post, 0, (int)ceil($diff / 2));
4701 2
          break;
4702
4703 2
        case STR_PAD_RIGHT:
4704 2 View Code Duplication
        default:
4705 2
          $post = str_repeat($pad_string, (int)ceil($diff / $ps_length));
4706 2
          $post = (string)self::substr($post, 0, $diff);
4707 2
          $pre = '';
4708 2
      }
4709
4710 2
      return $pre . $str . $post;
4711
    }
4712
4713 2
    return $str;
4714
  }
4715
4716
  /**
4717
   * Repeat a string.
4718
   *
4719
   * @param string $str        <p>
4720
   *                           The string to be repeated.
4721
   *                           </p>
4722
   * @param int    $multiplier <p>
4723
   *                           Number of time the input string should be
4724
   *                           repeated.
4725
   *                           </p>
4726
   *                           <p>
4727
   *                           multiplier has to be greater than or equal to 0.
4728
   *                           If the multiplier is set to 0, the function
4729
   *                           will return an empty string.
4730
   *                           </p>
4731
   *
4732
   * @return string <p>The repeated string.</p>
4733
   */
4734 1
  public static function str_repeat($str, $multiplier)
4735
  {
4736 1
    $str = self::filter($str);
4737
4738 1
    return str_repeat($str, $multiplier);
4739
  }
4740
4741
  /**
4742
   * INFO: This is only a wrapper for "str_replace()"  -> the original functions is already UTF-8 safe.
4743
   *
4744
   * Replace all occurrences of the search string with the replacement string
4745
   *
4746
   * @link http://php.net/manual/en/function.str-replace.php
4747
   *
4748
   * @param mixed $search  <p>
4749
   *                       The value being searched for, otherwise known as the needle.
4750
   *                       An array may be used to designate multiple needles.
4751
   *                       </p>
4752
   * @param mixed $replace <p>
4753
   *                       The replacement value that replaces found search
4754
   *                       values. An array may be used to designate multiple replacements.
4755
   *                       </p>
4756
   * @param mixed $subject <p>
4757
   *                       The string or array being searched and replaced on,
4758
   *                       otherwise known as the haystack.
4759
   *                       </p>
4760
   *                       <p>
4761
   *                       If subject is an array, then the search and
4762
   *                       replace is performed with every entry of
4763
   *                       subject, and the return value is an array as
4764
   *                       well.
4765
   *                       </p>
4766
   * @param int   $count   [optional] If passed, this will hold the number of matched and replaced needles.
4767
   *
4768
   * @return mixed <p>This function returns a string or an array with the replaced values.</p>
4769
   */
4770 12
  public static function str_replace($search, $replace, $subject, &$count = null)
4771
  {
4772 12
    return str_replace($search, $replace, $subject, $count);
4773
  }
4774
4775
  /**
4776
   * Replace the first "$search"-term with the "$replace"-term.
4777
   *
4778
   * @param string $search
4779
   * @param string $replace
4780
   * @param string $subject
4781
   *
4782
   * @return string
4783
   */
4784 1
  public static function str_replace_first($search, $replace, $subject)
4785
  {
4786 1
    $pos = self::strpos($subject, $search);
4787
4788 1
    if ($pos !== false) {
4789 1
      return self::substr_replace($subject, $replace, $pos, self::strlen($search));
4790
    }
4791
4792 1
    return $subject;
4793
  }
4794
4795
  /**
4796
   * Shuffles all the characters in the string.
4797
   *
4798
   * @param string $str <p>The input string</p>
4799
   *
4800
   * @return string <p>The shuffled string.</p>
4801
   */
4802 1
  public static function str_shuffle($str)
4803
  {
4804 1
    $array = self::split($str);
4805
4806 1
    shuffle($array);
4807
4808 1
    return implode('', $array);
4809
  }
4810
4811
  /**
4812
   * Sort all characters according to code points.
4813
   *
4814
   * @param string $str    <p>A UTF-8 string.</p>
4815
   * @param bool   $unique <p>Sort unique. If <strong>true</strong>, repeated characters are ignored.</p>
4816
   * @param bool   $desc   <p>If <strong>true</strong>, will sort characters in reverse code point order.</p>
4817
   *
4818
   * @return string <p>String of sorted characters.</p>
4819
   */
4820 1
  public static function str_sort($str, $unique = false, $desc = false)
4821
  {
4822 1
    $array = self::codepoints($str);
4823
4824 1
    if ($unique) {
4825 1
      $array = array_flip(array_flip($array));
4826 1
    }
4827
4828 1
    if ($desc) {
4829 1
      arsort($array);
4830 1
    } else {
4831 1
      asort($array);
4832
    }
4833
4834 1
    return self::string($array);
4835
  }
4836
4837
  /**
4838
   * Split a string into an array.
4839
   *
4840
   * @param string $str
4841
   * @param int    $len
4842
   *
4843
   * @return array
4844
   */
4845 22
  public static function str_split($str, $len = 1)
4846
  {
4847 22
    $str = (string)$str;
4848
4849 22
    if (!isset($str[0])) {
4850 1
      return array();
4851
    }
4852
4853 21
    $len = (int)$len;
4854
4855 21
    if ($len < 1) {
4856
      return str_split($str, $len);
4857
    }
4858
4859
    /** @noinspection PhpInternalEntityUsedInspection */
4860 21
    preg_match_all('/' . self::GRAPHEME_CLUSTER_RX . '/u', $str, $a);
4861 21
    $a = $a[0];
4862
4863 21
    if ($len === 1) {
4864 21
      return $a;
4865
    }
4866
4867 1
    $arrayOutput = array();
4868 1
    $p = -1;
4869
4870
    /** @noinspection PhpForeachArrayIsUsedAsValueInspection */
4871 1
    foreach ($a as $l => $a) {
4872 1
      if ($l % $len) {
4873 1
        $arrayOutput[$p] .= $a;
4874 1
      } else {
4875 1
        $arrayOutput[++$p] = $a;
4876
      }
4877 1
    }
4878
4879 1
    return $arrayOutput;
4880
  }
4881
4882
  /**
4883
   * Check if the string starts with the given substring.
4884
   *
4885
   * @param string $haystack <p>The string to search in.</p>
4886
   * @param string $needle   <p>The substring to search for.</p>
4887
   *
4888
   * @return bool
4889
   */
4890 2 View Code Duplication
  public static function str_starts_with($haystack, $needle)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
4891
  {
4892 2
    $haystack = (string)$haystack;
4893 2
    $needle = (string)$needle;
4894
4895 2
    if (!isset($haystack[0], $needle[0])) {
4896 1
      return false;
4897
    }
4898
4899 2
    if (self::strpos($haystack, $needle) === 0) {
4900 2
      return true;
4901
    }
4902
4903 2
    return false;
4904
  }
4905
4906
  /**
4907
   * Get a binary representation of a specific string.
4908
   *
4909
   * @param string $str <p>The input string.</p>
4910
   *
4911
   * @return string
4912
   */
4913 1
  public static function str_to_binary($str)
4914
  {
4915 1
    $str = (string)$str;
4916
4917 1
    $value = unpack('H*', $str);
4918
4919 1
    return base_convert($value[1], 16, 2);
4920
  }
4921
4922
  /**
4923
   * Convert a string into an array of words.
4924
   *
4925
   * @param string   $str
4926
   * @param string   $charList          <p>Additional chars for the definition of "words".</p>
4927
   * @param bool     $removeEmptyValues <p>Remove empty values.</p>
4928
   * @param null|int $removeShortValues
4929
   *
4930
   * @return array
4931
   */
4932 10
  public static function str_to_words($str, $charList = '', $removeEmptyValues = false, $removeShortValues = null)
4933
  {
4934 10
    $str = (string)$str;
4935
4936 10
    if ($removeShortValues !== null) {
4937 1
      $removeShortValues = (int)$removeShortValues;
4938 1
    }
4939
4940 10
    if (!isset($str[0])) {
4941 2
      if ($removeEmptyValues === true) {
4942
        return array();
4943
      }
4944
4945 2
      return array('');
4946
    }
4947
4948 10
    $charList = self::rxClass($charList, '\pL');
4949
4950 10
    $return = \preg_split("/({$charList}+(?:[\p{Pd}’']{$charList}+)*)/u", $str, -1, PREG_SPLIT_DELIM_CAPTURE);
4951
4952
    if (
4953
        $removeShortValues === null
4954 10
        &&
4955
        $removeEmptyValues === false
4956 10
    ) {
4957 10
      return $return;
4958
    }
4959
4960 1
    $tmpReturn = array();
4961 1
    foreach ($return as $returnValue) {
4962
      if (
4963
          $removeShortValues !== null
4964 1
          &&
4965 1
          self::strlen($returnValue) <= $removeShortValues
4966 1
      ) {
4967 1
        continue;
4968
      }
4969
4970
      if (
4971
          $removeEmptyValues === true
4972 1
          &&
4973 1
          trim($returnValue) === ''
4974 1
      ) {
4975 1
        continue;
4976
      }
4977
4978 1
      $tmpReturn[] = $returnValue;
4979 1
    }
4980
4981 1
    return $tmpReturn;
4982
  }
4983
4984
  /**
4985
   * alias for "UTF8::to_ascii()"
4986
   *
4987
   * @see UTF8::to_ascii()
4988
   *
4989
   * @param string $str
4990
   * @param string $unknown
4991
   * @param bool   $strict
4992
   *
4993
   * @return string
4994
   */
4995 7
  public static function str_transliterate($str, $unknown = '?', $strict = false)
4996
  {
4997 7
    return self::to_ascii($str, $unknown, $strict);
4998
  }
4999
5000
  /**
5001
   * Counts number of words in the UTF-8 string.
5002
   *
5003
   * @param string $str      <p>The input string.</p>
5004
   * @param int    $format   [optional] <p>
5005
   *                         <strong>0</strong> => return a number of words (default)<br>
5006
   *                         <strong>1</strong> => return an array of words<br>
5007
   *                         <strong>2</strong> => return an array of words with word-offset as key
5008
   *                         </p>
5009
   * @param string $charlist [optional] <p>Additional chars that contains to words and do not start a new word.</p>
5010
   *
5011
   * @return array|int <p>The number of words in the string</p>
5012
   */
5013 1
  public static function str_word_count($str, $format = 0, $charlist = '')
5014
  {
5015 1
    $strParts = self::str_to_words($str, $charlist);
5016
5017 1
    $len = count($strParts);
5018
5019 1
    if ($format === 1) {
5020
5021 1
      $numberOfWords = array();
5022 1
      for ($i = 1; $i < $len; $i += 2) {
5023 1
        $numberOfWords[] = $strParts[$i];
5024 1
      }
5025
5026 1
    } elseif ($format === 2) {
5027
5028 1
      $numberOfWords = array();
5029 1
      $offset = self::strlen($strParts[0]);
5030 1
      for ($i = 1; $i < $len; $i += 2) {
5031 1
        $numberOfWords[$offset] = $strParts[$i];
5032 1
        $offset += self::strlen($strParts[$i]) + self::strlen($strParts[$i + 1]);
5033 1
      }
5034
5035 1
    } else {
5036
5037 1
      $numberOfWords = ($len - 1) / 2;
5038
5039
    }
5040
5041 1
    return $numberOfWords;
5042
  }
5043
5044
  /**
5045
   * Case-insensitive string comparison.
5046
   *
5047
   * INFO: Case-insensitive version of UTF8::strcmp()
5048
   *
5049
   * @param string $str1
5050
   * @param string $str2
5051
   *
5052
   * @return int <p>
5053
   *             <strong>&lt; 0</strong> if str1 is less than str2;<br>
5054
   *             <strong>&gt; 0</strong> if str1 is greater than str2,<br>
5055
   *             <strong>0</strong> if they are equal.
5056
   *             </p>
5057
   */
5058 11
  public static function strcasecmp($str1, $str2)
5059
  {
5060 11
    return self::strcmp(self::strtocasefold($str1), self::strtocasefold($str2));
5061
  }
5062
5063
  /**
5064
   * alias for "UTF8::strstr()"
5065
   *
5066
   * @see UTF8::strstr()
5067
   *
5068
   * @param string  $haystack
5069
   * @param string  $needle
5070
   * @param bool    $before_needle
5071
   * @param string  $encoding
5072
   * @param boolean $cleanUtf8
5073
   *
5074
   * @return string|false
5075
   */
5076 1
  public static function strchr($haystack, $needle, $before_needle = false, $encoding = 'UTF-8', $cleanUtf8 = false)
5077
  {
5078 1
    return self::strstr($haystack, $needle, $before_needle, $encoding, $cleanUtf8);
5079
  }
5080
5081
  /**
5082
   * Case-sensitive string comparison.
5083
   *
5084
   * @param string $str1
5085
   * @param string $str2
5086
   *
5087
   * @return int  <p>
5088
   *              <strong>&lt; 0</strong> if str1 is less than str2<br>
5089
   *              <strong>&gt; 0</strong> if str1 is greater than str2<br>
5090
   *              <strong>0</strong> if they are equal.
5091
   *              </p>
5092
   */
5093 14
  public static function strcmp($str1, $str2)
5094
  {
5095
    /** @noinspection PhpUndefinedClassInspection */
5096 14
    return $str1 . '' === $str2 . '' ? 0 : strcmp(
5097 13
        \Normalizer::normalize($str1, \Normalizer::NFD),
5098 13
        \Normalizer::normalize($str2, \Normalizer::NFD)
5099 14
    );
5100
  }
5101
5102
  /**
5103
   * Find length of initial segment not matching mask.
5104
   *
5105
   * @param string $str
5106
   * @param string $charList
5107
   * @param int    $offset
5108
   * @param int    $length
5109
   *
5110
   * @return int|null
5111
   */
5112 15
  public static function strcspn($str, $charList, $offset = 0, $length = null)
5113
  {
5114 15
    if ('' === $charList .= '') {
5115 1
      return null;
5116
    }
5117
5118 14 View Code Duplication
    if ($offset || $length !== null) {
5119 2
      $strTmp = self::substr($str, $offset, $length);
5120 2
      if ($strTmp === false) {
5121
        return null;
5122
      }
5123 2
      $str = (string)$strTmp;
5124 2
    }
5125
5126 14
    $str = (string)$str;
5127 14
    if (!isset($str[0])) {
5128 1
      return null;
5129
    }
5130
5131 13
    if (preg_match('/^(.*?)' . self::rxClass($charList) . '/us', $str, $length)) {
5132
      /** @noinspection OffsetOperationsInspection */
5133 13
      return self::strlen($length[1]);
5134
    }
5135
5136 1
    return self::strlen($str);
5137
  }
5138
5139
  /**
5140
   * alias for "UTF8::stristr()"
5141
   *
5142
   * @see UTF8::stristr()
5143
   *
5144
   * @param string  $haystack
5145
   * @param string  $needle
5146
   * @param bool    $before_needle
5147
   * @param string  $encoding
5148
   * @param boolean $cleanUtf8
5149
   *
5150
   * @return string|false
5151
   */
5152 1
  public static function strichr($haystack, $needle, $before_needle = false, $encoding = 'UTF-8', $cleanUtf8 = false)
5153
  {
5154 1
    return self::stristr($haystack, $needle, $before_needle, $encoding, $cleanUtf8);
5155
  }
5156
5157
  /**
5158
   * Create a UTF-8 string from code points.
5159
   *
5160
   * INFO: opposite to UTF8::codepoints()
5161
   *
5162
   * @param array $array <p>Integer or Hexadecimal codepoints.</p>
5163
   *
5164
   * @return string <p>UTF-8 encoded string.</p>
5165
   */
5166 2
  public static function string(array $array)
5167
  {
5168 2
    return implode(
5169 2
        '',
5170 2
        array_map(
5171
            array(
5172 2
                '\\voku\\helper\\UTF8',
5173 2
                'chr',
5174 2
            ),
5175
            $array
5176 2
        )
5177 2
    );
5178
  }
5179
5180
  /**
5181
   * Checks if string starts with "BOM" (Byte Order Mark Character) character.
5182
   *
5183
   * @param string $str <p>The input string.</p>
5184
   *
5185
   * @return bool <p><strong>true</strong> if the string has BOM at the start, <strong>false</strong> otherwise.</p>
5186
   */
5187 3
  public static function string_has_bom($str)
5188
  {
5189 3
    foreach (self::$BOM as $bomString => $bomByteLength) {
5190 3
      if (0 === strpos($str, $bomString)) {
5191 3
        return true;
5192
      }
5193 3
    }
5194
5195 3
    return false;
5196
  }
5197
5198
  /**
5199
   * Strip HTML and PHP tags from a string + clean invalid UTF-8.
5200
   *
5201
   * @link http://php.net/manual/en/function.strip-tags.php
5202
   *
5203
   * @param string  $str            <p>
5204
   *                                The input string.
5205
   *                                </p>
5206
   * @param string  $allowable_tags [optional] <p>
5207
   *                                You can use the optional second parameter to specify tags which should
5208
   *                                not be stripped.
5209
   *                                </p>
5210
   *                                <p>
5211
   *                                HTML comments and PHP tags are also stripped. This is hardcoded and
5212
   *                                can not be changed with allowable_tags.
5213
   *                                </p>
5214
   * @param boolean $cleanUtf8      [optional] <p>Remove non UTF-8 chars from the string.</p>
5215
   *
5216
   * @return string <p>The stripped string.</p>
5217
   */
5218 2 View Code Duplication
  public static function strip_tags($str, $allowable_tags = null, $cleanUtf8 = false)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
5219
  {
5220 2
    $str = (string)$str;
5221
5222 2
    if (!isset($str[0])) {
5223 1
      return '';
5224
    }
5225
5226 2
    if ($cleanUtf8 === true) {
5227 1
      $str = self::clean($str);
5228 1
    }
5229
5230 2
    return strip_tags($str, $allowable_tags);
5231
  }
5232
5233
  /**
5234
   * Finds position of first occurrence of a string within another, case insensitive.
5235
   *
5236
   * @link http://php.net/manual/en/function.mb-stripos.php
5237
   *
5238
   * @param string  $haystack  <p>The string from which to get the position of the first occurrence of needle.</p>
5239
   * @param string  $needle    <p>The string to find in haystack.</p>
5240
   * @param int     $offset    [optional] <p>The position in haystack to start searching.</p>
5241
   * @param string  $encoding  [optional] <p>Set the charset.</p>
5242
   * @param boolean $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
5243
   *
5244
   * @return int|false <p>
5245
   *                   Return the numeric position of the first occurrence of needle in the haystack string,<br>
5246
   *                   or false if needle is not found.
5247
   *                   </p>
5248
   */
5249 10
  public static function stripos($haystack, $needle, $offset = null, $encoding = 'UTF-8', $cleanUtf8 = false)
5250
  {
5251 10
    $haystack = (string)$haystack;
5252 10
    $needle = (string)$needle;
5253 10
    $offset = (int)$offset;
5254
5255 10
    if (!isset($haystack[0], $needle[0])) {
5256 3
      return false;
5257
    }
5258
5259 9
    if ($cleanUtf8 === true) {
5260
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
5261
      // if invalid characters are found in $haystack before $needle
5262 1
      $haystack = self::clean($haystack);
5263 1
      $needle = self::clean($needle);
5264 1
    }
5265
5266 View Code Duplication
    if (
5267
        $encoding === 'UTF-8'
5268 9
        ||
5269 2
        $encoding === true || $encoding === false // INFO: the "bool"-check is only a fallback for old versions
5270 9
    ) {
5271 9
      $encoding = 'UTF-8';
5272 9
    } else {
5273 1
      $encoding = self::normalize_encoding($encoding, 'UTF-8');
5274
    }
5275
5276 9
    if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
5277
      self::checkForSupport();
5278
    }
5279
5280
    if (
5281
        $encoding === 'UTF-8' // INFO: "grapheme_stripos()" can't handle other encodings
5282 9
        &&
5283 9
        self::$SUPPORT['intl'] === true
5284 9
        &&
5285 9
        Bootup::is_php('5.4') === true
5286 9
    ) {
5287 9
      return \grapheme_stripos($haystack, $needle, $offset);
5288
    }
5289
5290
    // fallback to "mb_"-function via polyfill
5291 1
    return \mb_stripos($haystack, $needle, $offset, $encoding);
5292
  }
5293
5294
  /**
5295
   * Returns all of haystack starting from and including the first occurrence of needle to the end.
5296
   *
5297
   * @param string  $haystack      <p>The input string. Must be valid UTF-8.</p>
5298
   * @param string  $needle        <p>The string to look for. Must be valid UTF-8.</p>
5299
   * @param bool    $before_needle [optional] <p>
5300
   *                               If <b>TRUE</b>, grapheme_strstr() returns the part of the
5301
   *                               haystack before the first occurrence of the needle (excluding the needle).
5302
   *                               </p>
5303
   * @param string  $encoding      [optional] <p>Set the charset for e.g. "\mb_" function</p>
5304
   * @param boolean $cleanUtf8     [optional] <p>Remove non UTF-8 chars from the string.</p>
5305
   *
5306
   * @return false|string A sub-string,<br>or <strong>false</strong> if needle is not found.
5307
   */
5308 17
  public static function stristr($haystack, $needle, $before_needle = false, $encoding = 'UTF-8', $cleanUtf8 = false)
5309
  {
5310 17
    $haystack = (string)$haystack;
5311 17
    $needle = (string)$needle;
5312 17
    $before_needle = (bool)$before_needle;
5313
5314 17
    if (!isset($haystack[0], $needle[0])) {
5315 6
      return false;
5316
    }
5317
5318 11
    if ($encoding !== 'UTF-8') {
5319 1
      $encoding = self::normalize_encoding($encoding, 'UTF-8');
5320 1
    }
5321
5322 11
    if ($cleanUtf8 === true) {
5323
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
5324
      // if invalid characters are found in $haystack before $needle
5325 1
      $needle = self::clean($needle);
5326 1
      $haystack = self::clean($haystack);
5327 1
    }
5328
5329 11
    if (!$needle) {
5330
      return $haystack;
5331
    }
5332
5333 11
    if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
5334
      self::checkForSupport();
5335
    }
5336
5337 View Code Duplication
    if (
5338
        $encoding !== 'UTF-8'
5339 11
        &&
5340 1
        self::$SUPPORT['mbstring'] === false
5341 11
    ) {
5342
      trigger_error('UTF8::stristr() without mbstring cannot handle "' . $encoding . '" encoding', E_USER_WARNING);
5343
    }
5344
5345 11
    if (self::$SUPPORT['mbstring'] === true) {
5346 11
      return \mb_stristr($haystack, $needle, $before_needle, $encoding);
5347
    }
5348
5349
    if (
5350
        $encoding === 'UTF-8' // INFO: "grapheme_stripos()" can't handle other encodings
5351
        &&
5352
        self::$SUPPORT['intl'] === true
5353
        &&
5354
        Bootup::is_php('5.4') === true
5355
    ) {
5356
      return \grapheme_stristr($haystack, $needle, $before_needle);
5357
    }
5358
5359
    if (self::is_ascii($haystack) && self::is_ascii($needle)) {
5360
      return stristr($haystack, $needle);
5361
    }
5362
5363
    preg_match('/^(.*?)' . preg_quote($needle, '/') . '/usi', $haystack, $match);
5364
5365
    if (!isset($match[1])) {
5366
      return false;
5367
    }
5368
5369
    if ($before_needle) {
5370
      return $match[1];
5371
    }
5372
5373
    return self::substr($haystack, self::strlen($match[1]));
5374
  }
5375
5376
  /**
5377
   * Get the string length, not the byte-length!
5378
   *
5379
   * @link     http://php.net/manual/en/function.mb-strlen.php
5380
   *
5381
   * @param string  $str       <p>The string being checked for length.</p>
5382
   * @param string  $encoding  [optional] <p>Set the charset.</p>
5383
   * @param boolean $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
5384
   *
5385
   * @return int <p>The number of characters in the string $str having character encoding $encoding. (One multi-byte
5386
   *             character counted as +1)</p>
5387
   */
5388 88
  public static function strlen($str, $encoding = 'UTF-8', $cleanUtf8 = false)
5389
  {
5390 88
    $str = (string)$str;
5391
5392 88
    if (!isset($str[0])) {
5393 5
      return 0;
5394
    }
5395
5396 View Code Duplication
    if (
5397
        $encoding === 'UTF-8'
5398 87
        ||
5399 13
        $encoding === true || $encoding === false // INFO: the "bool"-check is only a fallback for old versions
5400 87
    ) {
5401 78
      $encoding = 'UTF-8';
5402 78
    } else {
5403 12
      $encoding = self::normalize_encoding($encoding, 'UTF-8');
5404
    }
5405
5406 87
    if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
5407
      self::checkForSupport();
5408
    }
5409
5410
    switch ($encoding) {
5411 87
      case 'ASCII':
5412 87
      case 'CP850':
5413
        if (
5414
            $encoding === 'CP850'
5415 10
            &&
5416 10
            self::$SUPPORT['mbstring_func_overload'] === false
5417 10
        ) {
5418 10
          return strlen($str);
5419
        }
5420
5421
        return \mb_strlen($str, '8BIT');
5422
    }
5423
5424 79
    if ($cleanUtf8 === true) {
5425
      // "\mb_strlen" and "\iconv_strlen" returns wrong length,
5426
      // if invalid characters are found in $str
5427 2
      $str = self::clean($str);
5428 2
    }
5429
5430 View Code Duplication
    if (
5431
        $encoding !== 'UTF-8'
5432 79
        &&
5433 2
        self::$SUPPORT['mbstring'] === false
5434 79
        &&
5435
        self::$SUPPORT['iconv'] === false
5436 79
    ) {
5437
      trigger_error('UTF8::strlen() without mbstring / iconv cannot handle "' . $encoding . '" encoding', E_USER_WARNING);
5438
    }
5439
5440
    if (
5441
        $encoding !== 'UTF-8'
5442 79
        &&
5443 2
        self::$SUPPORT['iconv'] === true
5444 79
        &&
5445 2
        self::$SUPPORT['mbstring'] === false
5446 79
    ) {
5447
      return \iconv_strlen($str, $encoding);
5448
    }
5449
5450 79
    if (self::$SUPPORT['mbstring'] === true) {
5451 79
      return \mb_strlen($str, $encoding);
5452
    }
5453
5454
    if (self::$SUPPORT['iconv'] === true) {
5455
      return \iconv_strlen($str, $encoding);
5456
    }
5457
5458
    if (
5459
        $encoding === 'UTF-8' // INFO: "grapheme_stripos()" can't handle other encodings
5460
        &&
5461
        self::$SUPPORT['intl'] === true
5462
        &&
5463
        Bootup::is_php('5.4') === true
5464
    ) {
5465
      return \grapheme_strlen($str);
5466
    }
5467
5468
    if (self::is_ascii($str)) {
5469
      return strlen($str);
5470
    }
5471
5472
    // fallback via vanilla php
5473
    preg_match_all('/./us', $str, $parts);
5474
    $returnTmp = count($parts[0]);
5475
    if ($returnTmp !== 0) {
5476
      return $returnTmp;
5477
    }
5478
5479
    // fallback to "mb_"-function via polyfill
5480
    return \mb_strlen($str, $encoding);
5481
  }
5482
5483
  /**
5484
   * Case insensitive string comparisons using a "natural order" algorithm.
5485
   *
5486
   * INFO: natural order version of UTF8::strcasecmp()
5487
   *
5488
   * @param string $str1 <p>The first string.</p>
5489
   * @param string $str2 <p>The second string.</p>
5490
   *
5491
   * @return int <strong>&lt; 0</strong> if str1 is less than str2<br>
5492
   *             <strong>&gt; 0</strong> if str1 is greater than str2<br>
5493
   *             <strong>0</strong> if they are equal
5494
   */
5495 1
  public static function strnatcasecmp($str1, $str2)
5496
  {
5497 1
    return self::strnatcmp(self::strtocasefold($str1), self::strtocasefold($str2));
5498
  }
5499
5500
  /**
5501
   * String comparisons using a "natural order" algorithm
5502
   *
5503
   * INFO: natural order version of UTF8::strcmp()
5504
   *
5505
   * @link  http://php.net/manual/en/function.strnatcmp.php
5506
   *
5507
   * @param string $str1 <p>The first string.</p>
5508
   * @param string $str2 <p>The second string.</p>
5509
   *
5510
   * @return int <strong>&lt; 0</strong> if str1 is less than str2;<br>
5511
   *             <strong>&gt; 0</strong> if str1 is greater than str2;<br>
5512
   *             <strong>0</strong> if they are equal
5513
   */
5514 2
  public static function strnatcmp($str1, $str2)
5515
  {
5516 2
    return $str1 . '' === $str2 . '' ? 0 : strnatcmp(self::strtonatfold($str1), self::strtonatfold($str2));
5517
  }
5518
5519
  /**
5520
   * Case-insensitive string comparison of the first n characters.
5521
   *
5522
   * @link  http://php.net/manual/en/function.strncasecmp.php
5523
   *
5524
   * @param string $str1 <p>The first string.</p>
5525
   * @param string $str2 <p>The second string.</p>
5526
   * @param int    $len  <p>The length of strings to be used in the comparison.</p>
5527
   *
5528
   * @return int <strong>&lt; 0</strong> if <i>str1</i> is less than <i>str2</i>;<br>
5529
   *             <strong>&gt; 0</strong> if <i>str1</i> is greater than <i>str2</i>;<br>
5530
   *             <strong>0</strong> if they are equal
5531
   */
5532 1
  public static function strncasecmp($str1, $str2, $len)
5533
  {
5534 1
    return self::strncmp(self::strtocasefold($str1), self::strtocasefold($str2), $len);
5535
  }
5536
5537
  /**
5538
   * String comparison of the first n characters.
5539
   *
5540
   * @link  http://php.net/manual/en/function.strncmp.php
5541
   *
5542
   * @param string $str1 <p>The first string.</p>
5543
   * @param string $str2 <p>The second string.</p>
5544
   * @param int    $len  <p>Number of characters to use in the comparison.</p>
5545
   *
5546
   * @return int <strong>&lt; 0</strong> if <i>str1</i> is less than <i>str2</i>;<br>
5547
   *             <strong>&gt; 0</strong> if <i>str1</i> is greater than <i>str2</i>;<br>
5548
   *             <strong>0</strong> if they are equal
5549
   */
5550 2
  public static function strncmp($str1, $str2, $len)
5551
  {
5552 2
    $str1 = (string)self::substr($str1, 0, $len);
5553 2
    $str2 = (string)self::substr($str2, 0, $len);
5554
5555 2
    return self::strcmp($str1, $str2);
5556
  }
5557
5558
  /**
5559
   * Search a string for any of a set of characters.
5560
   *
5561
   * @link  http://php.net/manual/en/function.strpbrk.php
5562
   *
5563
   * @param string $haystack  <p>The string where char_list is looked for.</p>
5564
   * @param string $char_list <p>This parameter is case sensitive.</p>
5565
   *
5566
   * @return string String starting from the character found, or false if it is not found.
5567
   */
5568 1
  public static function strpbrk($haystack, $char_list)
5569
  {
5570 1
    $haystack = (string)$haystack;
5571 1
    $char_list = (string)$char_list;
5572
5573 1
    if (!isset($haystack[0], $char_list[0])) {
5574 1
      return false;
5575
    }
5576
5577 1
    if (preg_match('/' . self::rxClass($char_list) . '/us', $haystack, $m)) {
5578 1
      return substr($haystack, strpos($haystack, $m[0]));
5579
    }
5580
5581 1
    return false;
5582
  }
5583
5584
  /**
5585
   * Find position of first occurrence of string in a string.
5586
   *
5587
   * @link http://php.net/manual/en/function.mb-strpos.php
5588
   *
5589
   * @param string  $haystack  <p>The string from which to get the position of the first occurrence of needle.</p>
5590
   * @param string  $needle    <p>The string to find in haystack.</p>
5591
   * @param int     $offset    [optional] <p>The search offset. If it is not specified, 0 is used.</p>
5592
   * @param string  $encoding  [optional] <p>Set the charset.</p>
5593
   * @param boolean $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
5594
   *
5595
   * @return int|false <p>
5596
   *                   The numeric position of the first occurrence of needle in the haystack string.<br>
5597
   *                   If needle is not found it returns false.
5598
   *                   </p>
5599
   */
5600 58
  public static function strpos($haystack, $needle, $offset = 0, $encoding = 'UTF-8', $cleanUtf8 = false)
5601
  {
5602 58
    $haystack = (string)$haystack;
5603 58
    $needle = (string)$needle;
5604
5605 58
    if (!isset($haystack[0], $needle[0])) {
5606 3
      return false;
5607
    }
5608
5609
    // init
5610 57
    $offset = (int)$offset;
5611
5612
    // iconv and mbstring do not support integer $needle
5613
5614 57
    if ((int)$needle === $needle && $needle >= 0) {
0 ignored issues
show
Unused Code Bug introduced by
The strict comparison === seems to always evaluate to false as the types of (int) $needle (integer) and $needle (string) can never be identical. Maybe you want to use a loose comparison == instead?
Loading history...
5615
      $needle = (string)self::chr($needle);
5616
    }
5617
5618 57
    if ($cleanUtf8 === true) {
5619
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
5620
      // if invalid characters are found in $haystack before $needle
5621 2
      $needle = self::clean($needle);
5622 2
      $haystack = self::clean($haystack);
5623 2
    }
5624
5625 View Code Duplication
    if (
5626
        $encoding === 'UTF-8'
5627 57
        ||
5628 42
        $encoding === true || $encoding === false // INFO: the "bool"-check is only a fallback for old versions
5629 57
    ) {
5630 17
      $encoding = 'UTF-8';
5631 17
    } else {
5632 41
      $encoding = self::normalize_encoding($encoding, 'UTF-8');
5633
    }
5634
5635 57
    if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
5636
      self::checkForSupport();
5637
    }
5638
5639
    if (
5640
        $encoding === 'CP850'
5641 57
        &&
5642 41
        self::$SUPPORT['mbstring_func_overload'] === false
5643 57
    ) {
5644 41
      return strpos($haystack, $needle, $offset);
5645
    }
5646
5647 View Code Duplication
    if (
5648
        $encoding !== 'UTF-8'
0 ignored issues
show
Comprehensibility introduced by
Consider adding parentheses for clarity. Current Interpretation: ($encoding !== 'UTF-8') ...PPORT['iconv'] === true, Probably Intended Meaning: $encoding !== ('UTF-8' &...PORT['iconv'] === true)

When comparing the result of a bit operation, we suggest to add explicit parenthesis and not to rely on PHP’s built-in operator precedence to ensure the code behaves as intended and to make it more readable.

Let’s take a look at these examples:

// Returns always int(0).
return 0 === $foo & 4;
return (0 === $foo) & 4;

// More likely intended return: true/false
return 0 === ($foo & 4);
Loading history...
5649 17
        &
5650 17
        self::$SUPPORT['iconv'] === true
5651 17
        &&
5652 1
        self::$SUPPORT['mbstring'] === false
5653 17
    ) {
5654
      trigger_error('UTF8::strpos() without mbstring / iconv cannot handle "' . $encoding . '" encoding', E_USER_WARNING);
5655
    }
5656
5657
    if (
5658
        $offset >= 0 // iconv_strpos() can't handle negative offset
5659 17
        &&
5660
        $encoding !== 'UTF-8'
5661 17
        &&
5662 1
        self::$SUPPORT['mbstring'] === false
5663 17
        &&
5664
        self::$SUPPORT['iconv'] === true
5665 17
    ) {
5666
      // ignore invalid negative offset to keep compatibility
5667
      // with php < 5.5.35, < 5.6.21, < 7.0.6
5668
      return \iconv_strpos($haystack, $needle, $offset > 0 ? $offset : 0, $encoding);
5669
    }
5670
5671 17
    if (self::$SUPPORT['mbstring'] === true) {
5672 17
      return \mb_strpos($haystack, $needle, $offset, $encoding);
5673
    }
5674
5675
    if (
5676
        $encoding === 'UTF-8' // INFO: "grapheme_stripos()" can't handle other encodings
5677
        &&
5678
        self::$SUPPORT['intl'] === true
5679
        &&
5680
        Bootup::is_php('5.4') === true
5681
    ) {
5682
      return \grapheme_strpos($haystack, $needle, $offset);
5683
    }
5684
5685
    if (
5686
        $offset >= 0 // iconv_strpos() can't handle negative offset
5687
        &&
5688
        self::$SUPPORT['iconv'] === true
5689
    ) {
5690
      // ignore invalid negative offset to keep compatibility
5691
      // with php < 5.5.35, < 5.6.21, < 7.0.6
5692
      return \iconv_strpos($haystack, $needle, $offset > 0 ? $offset : 0, $encoding);
5693
    }
5694
5695
    $haystackIsAscii = self::is_ascii($haystack);
5696
    if ($haystackIsAscii && self::is_ascii($needle)) {
5697
      return strpos($haystack, $needle, $offset);
5698
    }
5699
5700
    // fallback via vanilla php
5701
5702
    if ($haystackIsAscii) {
5703
      $haystackTmp = substr($haystack, $offset);
5704
    } else {
5705
      $haystackTmp = self::substr($haystack, $offset);
5706
    }
5707
    if ($haystackTmp === false) {
5708
      $haystackTmp = '';
5709
    }
5710
    $haystack = (string)$haystackTmp;
5711
5712
    if ($offset < 0) {
5713
      $offset = 0;
5714
    }
5715
5716
    $pos = strpos($haystack, $needle);
5717
    if ($pos === false) {
5718
      return false;
5719
    }
5720
5721
    $returnTmp = $offset + self::strlen(substr($haystack, 0, $pos));
5722
    if ($returnTmp !== false) {
5723
      return $returnTmp;
5724
    }
5725
5726
    // fallback to "mb_"-function via polyfill
5727
    return \mb_strpos($haystack, $needle, $offset, $encoding);
5728
  }
5729
5730
  /**
5731
   * Finds the last occurrence of a character in a string within another.
5732
   *
5733
   * @link http://php.net/manual/en/function.mb-strrchr.php
5734
   *
5735
   * @param string $haystack      <p>The string from which to get the last occurrence of needle.</p>
5736
   * @param string $needle        <p>The string to find in haystack</p>
5737
   * @param bool   $before_needle [optional] <p>
5738
   *                              Determines which portion of haystack
5739
   *                              this function returns.
5740
   *                              If set to true, it returns all of haystack
5741
   *                              from the beginning to the last occurrence of needle.
5742
   *                              If set to false, it returns all of haystack
5743
   *                              from the last occurrence of needle to the end,
5744
   *                              </p>
5745
   * @param string $encoding      [optional] <p>
5746
   *                              Character encoding name to use.
5747
   *                              If it is omitted, internal character encoding is used.
5748
   *                              </p>
5749
   * @param bool   $cleanUtf8     [optional] <p>Remove non UTF-8 chars from the string.</p>
5750
   *
5751
   * @return string|false The portion of haystack or false if needle is not found.
5752
   */
5753 1 View Code Duplication
  public static function strrchr($haystack, $needle, $before_needle = false, $encoding = 'UTF-8', $cleanUtf8 = false)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
5754
  {
5755 1
    if ($encoding !== 'UTF-8') {
5756 1
      $encoding = self::normalize_encoding($encoding, 'UTF-8');
5757 1
    }
5758
5759 1
    if ($cleanUtf8 === true) {
5760
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
5761
      // if invalid characters are found in $haystack before $needle
5762
      $needle = self::clean($needle);
5763
      $haystack = self::clean($haystack);
5764
    }
5765
5766
    // fallback to "mb_"-function via polyfill
5767 1
    return \mb_strrchr($haystack, $needle, $before_needle, $encoding);
5768
  }
5769
5770
  /**
5771
   * Reverses characters order in the string.
5772
   *
5773
   * @param string $str The input string
5774
   *
5775
   * @return string The string with characters in the reverse sequence
5776
   */
5777 4
  public static function strrev($str)
5778
  {
5779 4
    $str = (string)$str;
5780
5781 4
    if (!isset($str[0])) {
5782 2
      return '';
5783
    }
5784
5785 3
    return implode('', array_reverse(self::split($str)));
5786
  }
5787
5788
  /**
5789
   * Finds the last occurrence of a character in a string within another, case insensitive.
5790
   *
5791
   * @link http://php.net/manual/en/function.mb-strrichr.php
5792
   *
5793
   * @param string  $haystack      <p>The string from which to get the last occurrence of needle.</p>
5794
   * @param string  $needle        <p>The string to find in haystack.</p>
5795
   * @param bool    $before_needle [optional] <p>
5796
   *                               Determines which portion of haystack
5797
   *                               this function returns.
5798
   *                               If set to true, it returns all of haystack
5799
   *                               from the beginning to the last occurrence of needle.
5800
   *                               If set to false, it returns all of haystack
5801
   *                               from the last occurrence of needle to the end,
5802
   *                               </p>
5803
   * @param string  $encoding      [optional] <p>
5804
   *                               Character encoding name to use.
5805
   *                               If it is omitted, internal character encoding is used.
5806
   *                               </p>
5807
   * @param boolean $cleanUtf8     [optional] <p>Remove non UTF-8 chars from the string.</p>
5808
   *
5809
   * @return string|false <p>The portion of haystack or<br>false if needle is not found.</p>
5810
   */
5811 1 View Code Duplication
  public static function strrichr($haystack, $needle, $before_needle = false, $encoding = 'UTF-8', $cleanUtf8 = false)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
5812
  {
5813 1
    if ($encoding !== 'UTF-8') {
5814 1
      $encoding = self::normalize_encoding($encoding, 'UTF-8');
5815 1
    }
5816
5817 1
    if ($cleanUtf8 === true) {
5818
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
5819
      // if invalid characters are found in $haystack before $needle
5820
      $needle = self::clean($needle);
5821
      $haystack = self::clean($haystack);
5822
    }
5823
5824 1
    return \mb_strrichr($haystack, $needle, $before_needle, $encoding);
5825
  }
5826
5827
  /**
5828
   * Find position of last occurrence of a case-insensitive string.
5829
   *
5830
   * @param string  $haystack  <p>The string to look in.</p>
5831
   * @param string  $needle    <p>The string to look for.</p>
5832
   * @param int     $offset    [optional] <p>Number of characters to ignore in the beginning or end.</p>
5833
   * @param string  $encoding  [optional] <p>Set the charset.</p>
5834
   * @param boolean $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
5835
   *
5836
   * @return int|false <p>
5837
   *                   The numeric position of the last occurrence of needle in the haystack string.<br>If needle is
5838
   *                   not found, it returns false.
5839
   *                   </p>
5840
   */
5841 1
  public static function strripos($haystack, $needle, $offset = 0, $encoding = 'UTF-8', $cleanUtf8 = false)
5842
  {
5843 1
    if ((int)$needle === $needle && $needle >= 0) {
0 ignored issues
show
Unused Code Bug introduced by
The strict comparison === seems to always evaluate to false as the types of (int) $needle (integer) and $needle (string) can never be identical. Maybe you want to use a loose comparison == instead?
Loading history...
5844
      $needle = (string)self::chr($needle);
5845
    }
5846
5847
    // init
5848 1
    $haystack = (string)$haystack;
5849 1
    $needle = (string)$needle;
5850 1
    $offset = (int)$offset;
5851
5852 1
    if (!isset($haystack[0], $needle[0])) {
5853
      return false;
5854
    }
5855
5856 View Code Duplication
    if (
5857
        $cleanUtf8 === true
5858 1
        ||
5859
        $encoding === true // INFO: the "bool"-check is only a fallback for old versions
5860 1
    ) {
5861
      // \mb_strripos && iconv_strripos is not tolerant to invalid characters
5862
5863
      $needle = self::clean($needle);
5864
      $haystack = self::clean($haystack);
5865
    }
5866
5867 View Code Duplication
    if (
5868
        $encoding === 'UTF-8'
5869 1
        ||
5870
        $encoding === true || $encoding === false // INFO: the "bool"-check is only a fallback for old versions
5871 1
    ) {
5872 1
      $encoding = 'UTF-8';
5873 1
    } else {
5874
      $encoding = self::normalize_encoding($encoding, 'UTF-8');
5875
    }
5876
5877 1
    if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
5878
      self::checkForSupport();
5879
    }
5880
5881 View Code Duplication
    if (
5882
        $encoding !== 'UTF-8'
5883 1
        &&
5884
        self::$SUPPORT['mbstring'] === false
5885 1
    ) {
5886
      trigger_error('UTF8::strripos() without mbstring cannot handle "' . $encoding . '" encoding', E_USER_WARNING);
5887
    }
5888
5889 1
    if (self::$SUPPORT['mbstring'] === true) {
5890 1
      return \mb_strripos($haystack, $needle, $offset, $encoding);
5891
    }
5892
5893
    if (
5894
        $encoding === 'UTF-8' // INFO: "grapheme_stripos()" can't handle other encodings
5895
        &&
5896
        self::$SUPPORT['intl'] === true
5897
        &&
5898
        Bootup::is_php('5.4') === true
5899
    ) {
5900
      return \grapheme_strripos($haystack, $needle, $offset);
5901
    }
5902
5903
    // fallback via vanilla php
5904
5905
    return self::strrpos(self::strtoupper($haystack), self::strtoupper($needle), $offset, $encoding, $cleanUtf8);
5906
  }
5907
5908
  /**
5909
   * Find position of last occurrence of a string in a string.
5910
   *
5911
   * @link http://php.net/manual/en/function.mb-strrpos.php
5912
   *
5913
   * @param string     $haystack  <p>The string being checked, for the last occurrence of needle</p>
5914
   * @param string|int $needle    <p>The string to find in haystack.<br>Or a code point as int.</p>
5915
   * @param int        $offset    [optional] <p>May be specified to begin searching an arbitrary number of characters
5916
   *                              into the string. Negative values will stop searching at an arbitrary point prior to
5917
   *                              the end of the string.
5918
   *                              </p>
5919
   * @param string     $encoding  [optional] <p>Set the charset.</p>
5920
   * @param boolean    $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
5921
   *
5922
   * @return int|false <p>The numeric position of the last occurrence of needle in the haystack string.<br>If needle
5923
   *                   is not found, it returns false.</p>
5924
   */
5925 10
  public static function strrpos($haystack, $needle, $offset = null, $encoding = 'UTF-8', $cleanUtf8 = false)
5926
  {
5927 10
    if ((int)$needle === $needle && $needle >= 0) {
5928 2
      $needle = (string)self::chr($needle);
5929 2
    }
5930
5931
    // init
5932 10
    $haystack = (string)$haystack;
5933 10
    $needle = (string)$needle;
5934 10
    $offset = (int)$offset;
5935
5936 10
    if (!isset($haystack[0], $needle[0])) {
5937 2
      return false;
5938
    }
5939
5940 View Code Duplication
    if (
5941
        $cleanUtf8 === true
5942 9
        ||
5943
        $encoding === true // INFO: the "bool"-check is only a fallback for old versions
5944 9
    ) {
5945
      // \mb_strrpos && iconv_strrpos is not tolerant to invalid characters
5946 3
      $needle = self::clean($needle);
5947 3
      $haystack = self::clean($haystack);
5948 3
    }
5949
5950 View Code Duplication
    if (
5951
        $encoding === 'UTF-8'
5952 9
        ||
5953 1
        $encoding === true || $encoding === false // INFO: the "bool"-check is only a fallback for old versions
5954 9
    ) {
5955 9
      $encoding = 'UTF-8';
5956 9
    } else {
5957 1
      $encoding = self::normalize_encoding($encoding, 'UTF-8');
5958
    }
5959
5960 9
    if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
5961
      self::checkForSupport();
5962
    }
5963
5964 View Code Duplication
    if (
5965
        $encoding !== 'UTF-8'
5966 9
        &&
5967 1
        self::$SUPPORT['mbstring'] === false
5968 9
    ) {
5969
      trigger_error('UTF8::strrpos() without mbstring cannot handle "' . $encoding . '" encoding', E_USER_WARNING);
5970
    }
5971
5972 9
    if (self::$SUPPORT['mbstring'] === true) {
5973 9
      return \mb_strrpos($haystack, $needle, $offset, $encoding);
5974
    }
5975
5976
    if (
5977
        $encoding === 'UTF-8' // INFO: "grapheme_stripos()" can't handle other encodings
5978
        &&
5979
        self::$SUPPORT['intl'] === true
5980
        &&
5981
        Bootup::is_php('5.4') === true
5982
    ) {
5983
      return \grapheme_strrpos($haystack, $needle, $offset);
5984
    }
5985
5986
    // fallback via vanilla php
5987
5988
    $haystackTmp = null;
5989
    if ($offset > 0) {
5990
      $haystackTmp = self::substr($haystack, $offset);
5991
    } elseif ($offset < 0) {
5992
      $haystackTmp = self::substr($haystack, 0, $offset);
5993
      $offset = 0;
5994
    }
5995
5996
    if ($haystackTmp !== null) {
5997
      if ($haystackTmp === false) {
5998
        $haystackTmp = '';
5999
      }
6000
      $haystack = (string)$haystackTmp;
6001
    }
6002
6003
    $pos = strrpos($haystack, $needle);
6004
    if ($pos === false) {
6005
      return false;
6006
    }
6007
6008
    return $offset + self::strlen(substr($haystack, 0, $pos));
6009
  }
6010
6011
  /**
6012
   * Finds the length of the initial segment of a string consisting entirely of characters contained within a given
6013
   * mask.
6014
   *
6015
   * @param string $str    <p>The input string.</p>
6016
   * @param string $mask   <p>The mask of chars</p>
6017
   * @param int    $offset [optional]
6018
   * @param int    $length [optional]
6019
   *
6020
   * @return int
6021
   */
6022 10
  public static function strspn($str, $mask, $offset = 0, $length = null)
6023
  {
6024 10 View Code Duplication
    if ($offset || $length !== null) {
6025 2
      $strTmp = self::substr($str, $offset, $length);
6026 2
      if ($strTmp === false) {
6027
        $strTmp = '';
6028
      }
6029 2
      $str = (string)$strTmp;
6030 2
    }
6031
6032 10
    $str = (string)$str;
6033 10
    if (!isset($str[0], $mask[0])) {
6034 2
      return 0;
6035
    }
6036
6037 8
    return preg_match('/^' . self::rxClass($mask) . '+/u', $str, $str) ? self::strlen($str[0]) : 0;
6038
  }
6039
6040
  /**
6041
   * Returns part of haystack string from the first occurrence of needle to the end of haystack.
6042
   *
6043
   * @param string  $haystack      <p>The input string. Must be valid UTF-8.</p>
6044
   * @param string  $needle        <p>The string to look for. Must be valid UTF-8.</p>
6045
   * @param bool    $before_needle [optional] <p>
6046
   *                               If <b>TRUE</b>, strstr() returns the part of the
6047
   *                               haystack before the first occurrence of the needle (excluding the needle).
6048
   *                               </p>
6049
   * @param string  $encoding      [optional] <p>Set the charset.</p>
6050
   * @param boolean $cleanUtf8     [optional] <p>Remove non UTF-8 chars from the string.</p>
6051
   *
6052
   * @return string|false A sub-string,<br>or <strong>false</strong> if needle is not found.
6053
   */
6054 2
  public static function strstr($haystack, $needle, $before_needle = false, $encoding = 'UTF-8', $cleanUtf8 = false)
6055
  {
6056 2
    $haystack = (string)$haystack;
6057 2
    $needle = (string)$needle;
6058
6059 2
    if (!isset($haystack[0], $needle[0])) {
6060 1
      return false;
6061
    }
6062
6063 2
    if ($cleanUtf8 === true) {
6064
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
6065
      // if invalid characters are found in $haystack before $needle
6066
      $needle = self::clean($needle);
6067
      $haystack = self::clean($haystack);
6068
    }
6069
6070 2
    if ($encoding !== 'UTF-8') {
6071 1
      $encoding = self::normalize_encoding($encoding, 'UTF-8');
6072 1
    }
6073
6074 2
    if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
6075
      self::checkForSupport();
6076
    }
6077
6078 View Code Duplication
    if (
6079
        $encoding !== 'UTF-8'
6080 2
        &&
6081 1
        self::$SUPPORT['mbstring'] === false
6082 2
    ) {
6083
      trigger_error('UTF8::strstr() without mbstring cannot handle "' . $encoding . '" encoding', E_USER_WARNING);
6084
    }
6085
6086 2
    if (self::$SUPPORT['mbstring'] === true) {
6087 2
      return \mb_strstr($haystack, $needle, $before_needle, $encoding);
6088
    }
6089
6090
    if (
6091
        $encoding === 'UTF-8' // INFO: "grapheme_stripos()" can't handle other encodings
6092
        &&
6093
        self::$SUPPORT['intl'] === true
6094
        &&
6095
        Bootup::is_php('5.4') === true
6096
    ) {
6097
      return \grapheme_strstr($haystack, $needle, $before_needle);
6098
    }
6099
6100
    preg_match('/^(.*?)' . preg_quote($needle, '/') . '/us', $haystack, $match);
6101
6102
    if (!isset($match[1])) {
6103
      return false;
6104
    }
6105
6106
    if ($before_needle) {
6107
      return $match[1];
6108
    }
6109
6110
    return self::substr($haystack, self::strlen($match[1]));
6111
  }
6112
6113
  /**
6114
   * Unicode transformation for case-less matching.
6115
   *
6116
   * @link http://unicode.org/reports/tr21/tr21-5.html
6117
   *
6118
   * @param string  $str       <p>The input string.</p>
6119
   * @param bool    $full      [optional] <p>
6120
   *                           <b>true</b>, replace full case folding chars (default)<br>
6121
   *                           <b>false</b>, use only limited static array [UTF8::$commonCaseFold]
6122
   *                           </p>
6123
   * @param boolean $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
6124
   *
6125
   * @return string
6126
   */
6127 13
  public static function strtocasefold($str, $full = true, $cleanUtf8 = false)
6128
  {
6129
    // init
6130 13
    $str = (string)$str;
6131
6132 13
    if (!isset($str[0])) {
6133 4
      return '';
6134
    }
6135
6136 12
    static $COMMON_CASE_FOLD_KEYS_CACHE = null;
6137 12
    static $COMMAN_CASE_FOLD_VALUES_CACHE = null;
6138
6139 12
    if ($COMMON_CASE_FOLD_KEYS_CACHE === null) {
6140 1
      $COMMON_CASE_FOLD_KEYS_CACHE = array_keys(self::$COMMON_CASE_FOLD);
6141 1
      $COMMAN_CASE_FOLD_VALUES_CACHE = array_values(self::$COMMON_CASE_FOLD);
6142 1
    }
6143
6144 12
    $str = (string)str_replace($COMMON_CASE_FOLD_KEYS_CACHE, $COMMAN_CASE_FOLD_VALUES_CACHE, $str);
6145
6146 12
    if ($full) {
6147
6148 12
      static $FULL_CASE_FOLD = null;
6149
6150 12
      if ($FULL_CASE_FOLD === null) {
6151 1
        $FULL_CASE_FOLD = self::getData('caseFolding_full');
6152 1
      }
6153
6154
      /** @noinspection OffsetOperationsInspection */
6155 12
      $str = (string)str_replace($FULL_CASE_FOLD[0], $FULL_CASE_FOLD[1], $str);
6156 12
    }
6157
6158 12
    if ($cleanUtf8 === true) {
6159 1
      $str = self::clean($str);
6160 1
    }
6161
6162 12
    return self::strtolower($str);
6163
  }
6164
6165
  /**
6166
   * Make a string lowercase.
6167
   *
6168
   * @link http://php.net/manual/en/function.mb-strtolower.php
6169
   *
6170
   * @param string      $str       <p>The string being lowercased.</p>
6171
   * @param string      $encoding  [optional] <p>Set the charset for e.g. "\mb_" function</p>
6172
   * @param boolean     $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
6173
   * @param string|null $lang      [optional] <p>Set the language for special cases: az, el, lt, tr</p>
6174
   *
6175
   * @return string str with all alphabetic characters converted to lowercase.
6176
   */
6177 25 View Code Duplication
  public static function strtolower($str, $encoding = 'UTF-8', $cleanUtf8 = false, $lang = null)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
6178
  {
6179
    // init
6180 25
    $str = (string)$str;
6181
6182 25
    if (!isset($str[0])) {
6183 3
      return '';
6184
    }
6185
6186 23
    if ($cleanUtf8 === true) {
6187
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
6188
      // if invalid characters are found in $haystack before $needle
6189 1
      $str = self::clean($str);
6190 1
    }
6191
6192 23
    if ($encoding !== 'UTF-8') {
6193 2
      $encoding = self::normalize_encoding($encoding, 'UTF-8');
6194 2
    }
6195
6196 23
    if ($lang !== null) {
6197 1
      if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
6198
        self::checkForSupport();
6199
      }
6200
6201
      if (
6202 1
          self::$SUPPORT['intl'] === true
6203 1
          &&
6204 1
          Bootup::is_php('5.4') === true
6205 1
      ) {
6206
6207 1
        $langCode = $lang . '-Lower';
6208 1
        if (!in_array($langCode, self::$SUPPORT['intl__transliterator_list_ids'], true)) {
6209
          trigger_error('UTF8::strtolower() without intl for special language: ' . $lang, E_USER_WARNING);
6210
6211
          $langCode = 'Any-Lower';
6212
        }
6213
6214 1
        return transliterator_transliterate($langCode, $str);
6215
      }
6216
6217
      trigger_error('UTF8::strtolower() without intl + PHP >= 5.4 cannot handle the "lang"-parameter: ' . $lang, E_USER_WARNING);
6218
    }
6219
6220 23
    return \mb_strtolower($str, $encoding);
6221
  }
6222
6223
  /**
6224
   * Generic case sensitive transformation for collation matching.
6225
   *
6226
   * @param string $str <p>The input string</p>
6227
   *
6228
   * @return string
6229
   */
6230 3
  private static function strtonatfold($str)
6231
  {
6232
    /** @noinspection PhpUndefinedClassInspection */
6233 3
    return preg_replace('/\p{Mn}+/u', '', \Normalizer::normalize($str, \Normalizer::NFD));
6234
  }
6235
6236
  /**
6237
   * Make a string uppercase.
6238
   *
6239
   * @link http://php.net/manual/en/function.mb-strtoupper.php
6240
   *
6241
   * @param string      $str       <p>The string being uppercased.</p>
6242
   * @param string      $encoding  [optional] <p>Set the charset.</p>
6243
   * @param boolean     $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
6244
   * @param string|null $lang      [optional] <p>Set the language for special cases: az, el, lt, tr</p>
6245
   *
6246
   * @return string str with all alphabetic characters converted to uppercase.
6247
   */
6248 19 View Code Duplication
  public static function strtoupper($str, $encoding = 'UTF-8', $cleanUtf8 = false, $lang = null)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
6249
  {
6250 19
    $str = (string)$str;
6251
6252 19
    if (!isset($str[0])) {
6253 3
      return '';
6254
    }
6255
6256 17
    if ($cleanUtf8 === true) {
6257
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
6258
      // if invalid characters are found in $haystack before $needle
6259 1
      $str = self::clean($str);
6260 1
    }
6261
6262 17
    if ($encoding !== 'UTF-8') {
6263 2
      $encoding = self::normalize_encoding($encoding, 'UTF-8');
6264 2
    }
6265
6266 17
    if ($lang !== null) {
6267 1
      if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
6268
        self::checkForSupport();
6269
      }
6270
6271
      if (
6272 1
          self::$SUPPORT['intl'] === true
6273 1
          &&
6274 1
          Bootup::is_php('5.4') === true
6275 1
      ) {
6276
6277 1
        $langCode = $lang . '-Upper';
6278 1
        if (!in_array($langCode, self::$SUPPORT['intl__transliterator_list_ids'], true)) {
6279
          trigger_error('UTF8::strtoupper() without intl for special language: ' . $lang, E_USER_WARNING);
6280
6281
          $langCode = 'Any-Upper';
6282
        }
6283
6284 1
        return transliterator_transliterate($langCode, $str);
6285
      }
6286
6287
      trigger_error('UTF8::strtolower() without intl + PHP >= 5.4 cannot handle the "lang"-parameter: ' . $lang, E_USER_WARNING);
6288
    }
6289
6290 17
    return \mb_strtoupper($str, $encoding);
6291
  }
6292
6293
  /**
6294
   * Translate characters or replace sub-strings.
6295
   *
6296
   * @link  http://php.net/manual/en/function.strtr.php
6297
   *
6298
   * @param string          $str  <p>The string being translated.</p>
6299
   * @param string|string[] $from <p>The string replacing from.</p>
6300
   * @param string|string[] $to   <p>The string being translated to to.</p>
6301
   *
6302
   * @return string <p>
6303
   *                This function returns a copy of str, translating all occurrences of each character in from to the
6304
   *                corresponding character in to.
6305
   *                </p>
6306
   */
6307 1
  public static function strtr($str, $from, $to = INF)
6308
  {
6309 1
    $str = (string)$str;
6310
6311 1
    if (!isset($str[0])) {
6312
      return '';
6313
    }
6314
6315 1
    if ($from === $to) {
6316
      return $str;
6317
    }
6318
6319 1
    if (INF !== $to) {
6320 1
      $from = self::str_split($from);
0 ignored issues
show
Bug introduced by
It seems like $from defined by self::str_split($from) on line 6320 can also be of type array<integer,string>; however, voku\helper\UTF8::str_split() does only seem to accept string, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
6321 1
      $to = self::str_split($to);
0 ignored issues
show
Bug introduced by
It seems like $to defined by self::str_split($to) on line 6321 can also be of type array<integer,string>; however, voku\helper\UTF8::str_split() does only seem to accept string, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

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

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
6322 1
      $countFrom = count($from);
6323 1
      $countTo = count($to);
6324
6325 1
      if ($countFrom > $countTo) {
6326 1
        $from = array_slice($from, 0, $countTo);
6327 1
      } elseif ($countFrom < $countTo) {
6328 1
        $to = array_slice($to, 0, $countFrom);
6329 1
      }
6330
6331 1
      $from = array_combine($from, $to);
6332 1
    }
6333
6334 1
    if (is_string($from)) {
6335 1
      return str_replace($from, '', $str);
6336
    }
6337
6338 1
    return strtr($str, $from);
6339
  }
6340
6341
  /**
6342
   * Return the width of a string.
6343
   *
6344
   * @param string  $str       <p>The input string.</p>
6345
   * @param string  $encoding  [optional] <p>Default is UTF-8</p>
6346
   * @param boolean $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
6347
   *
6348
   * @return int
6349
   */
6350 1
  public static function strwidth($str, $encoding = 'UTF-8', $cleanUtf8 = false)
6351
  {
6352 1
    if ($encoding !== 'UTF-8') {
6353 1
      $encoding = self::normalize_encoding($encoding, 'UTF-8');
6354 1
    }
6355
6356 1
    if ($cleanUtf8 === true) {
6357
      // iconv and mbstring are not tolerant to invalid encoding
6358
      // further, their behaviour is inconsistent with that of PHP's substr
6359 1
      $str = self::clean($str);
6360 1
    }
6361
6362
    // fallback to "mb_"-function via polyfill
6363 1
    return \mb_strwidth($str, $encoding);
6364
  }
6365
6366
  /**
6367
   * Changes all keys in an array.
6368
   *
6369
   * @param array $array <p>The array to work on</p>
6370
   * @param int   $case  [optional] <p> Either <strong>CASE_UPPER</strong><br>
6371
   *                     or <strong>CASE_LOWER</strong> (default)</p>
6372
   *
6373
   * @return array|false <p>An array with its keys lower or uppercased, or false if
6374
   *                     input is not an array.</p>
6375
   */
6376 1
  public static function array_change_key_case($array, $case = CASE_LOWER)
6377
  {
6378 1
    if (!is_array($array)) {
6379
      return false;
6380
    }
6381
6382
    if (
6383
        $case !== CASE_LOWER
6384 1
        &&
6385
        $case !== CASE_UPPER
6386 1
    ) {
6387
      $case = CASE_UPPER;
6388
    }
6389
6390 1
    $return = array();
6391 1
    foreach ($array as $key => $value) {
6392 1
      if ($case === CASE_LOWER) {
6393 1
        $key = self::strtolower($key);
6394 1
      } else {
6395 1
        $key = self::strtoupper($key);
6396
      }
6397
6398 1
      $return[$key] = $value;
6399 1
    }
6400
6401 1
    return $return;
6402
  }
6403
6404
  /**
6405
   * Get part of a string.
6406
   *
6407
   * @link http://php.net/manual/en/function.mb-substr.php
6408
   *
6409
   * @param string  $str       <p>The string being checked.</p>
6410
   * @param int     $offset    <p>The first position used in str.</p>
6411
   * @param int     $length    [optional] <p>The maximum length of the returned string.</p>
6412
   * @param string  $encoding  [optional] <p>Default is UTF-8</p>
6413
   * @param boolean $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
6414
   *
6415
   * @return string|false <p>The portion of <i>str</i> specified by the <i>offset</i> and
6416
   *                      <i>length</i> parameters.</p><p>If <i>str</i> is shorter than <i>offset</i>
6417
   *                      characters long, <b>FALSE</b> will be returned.</p>
6418
   */
6419 76
  public static function substr($str, $offset = 0, $length = null, $encoding = 'UTF-8', $cleanUtf8 = false)
6420
  {
6421
    // init
6422 76
    $str = (string)$str;
6423
6424 76
    if (!isset($str[0])) {
6425 10
      return '';
6426
    }
6427
6428
    // Empty string
6429 74
    if ($length === 0) {
6430 3
      return '';
6431
    }
6432
6433 73
    if ($cleanUtf8 === true) {
6434
      // iconv and mbstring are not tolerant to invalid encoding
6435
      // further, their behaviour is inconsistent with that of PHP's substr
6436 1
      $str = self::clean($str);
6437 1
    }
6438
6439
    // Whole string
6440 73
    if (!$offset && $length === null) {
6441 1
      return $str;
6442
    }
6443
6444 72
    $str_length = 0;
6445 72
    if ($offset || $length === null) {
6446 49
      $str_length = (int)self::strlen($str, $encoding);
6447 49
    }
6448
6449
    // Impossible
6450 72
    if ($offset && $offset > $str_length) {
6451 2
      return false;
6452
    }
6453
6454 70
    if ($length === null) {
6455 34
      $length = $str_length;
6456 34
    } else {
6457 59
      $length = (int)$length;
6458
    }
6459
6460 View Code Duplication
    if (
6461
        $encoding === 'UTF-8'
6462 70
        ||
6463 23
        $encoding === true || $encoding === false // INFO: the "bool"-check is only a fallback for old versions
6464 70
    ) {
6465 49
      $encoding = 'UTF-8';
6466 49
    } else {
6467 22
      $encoding = self::normalize_encoding($encoding, 'UTF-8');
6468
    }
6469
6470 70
    if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
6471
      self::checkForSupport();
6472
    }
6473
6474
    if (
6475
        $encoding === 'CP850'
6476 70
        &&
6477 21
        self::$SUPPORT['mbstring_func_overload'] === false
6478 70
    ) {
6479 21
      return substr($str, $offset, $length === null ? $str_length : $length);
6480
    }
6481
6482 View Code Duplication
    if (
6483
        $encoding !== 'UTF-8'
6484 49
        &&
6485 1
        self::$SUPPORT['mbstring'] === false
6486 49
    ) {
6487
      trigger_error('UTF8::substr() without mbstring cannot handle "' . $encoding . '" encoding', E_USER_WARNING);
6488
    }
6489
6490 49
    if (self::$SUPPORT['mbstring'] === true) {
6491 49
      return \mb_substr($str, $offset, $length, $encoding);
6492
    }
6493
6494
    if (
6495
        $encoding === 'UTF-8' // INFO: "grapheme_stripos()" can't handle other encodings
6496
        &&
6497
        self::$SUPPORT['intl'] === true
6498
        &&
6499
        Bootup::is_php('5.4') === true
6500
    ) {
6501
      return \grapheme_substr($str, $offset, $length);
6502
    }
6503
6504
    if (
6505
        $length >= 0 // "iconv_substr()" can't handle negative length
6506
        &&
6507
        self::$SUPPORT['iconv'] === true
6508
    ) {
6509
      return \iconv_substr($str, $offset, $length);
6510
    }
6511
6512
    if (self::is_ascii($str)) {
6513
      return ($length === null) ?
6514
          substr($str, $offset) :
6515
          substr($str, $offset, $length);
6516
    }
6517
6518
    // fallback via vanilla php
6519
6520
    // split to array, and remove invalid characters
6521
    $array = self::split($str);
6522
6523
    // extract relevant part, and join to make sting again
6524
    return implode('', array_slice($array, $offset, $length));
6525
  }
6526
6527
  /**
6528
   * Binary safe comparison of two strings from an offset, up to length characters.
6529
   *
6530
   * @param string  $str1               <p>The main string being compared.</p>
6531
   * @param string  $str2               <p>The secondary string being compared.</p>
6532
   * @param int     $offset             [optional] <p>The start position for the comparison. If negative, it starts
6533
   *                                    counting from the end of the string.</p>
6534
   * @param int     $length             [optional] <p>The length of the comparison. The default value is the largest of
6535
   *                                    the length of the str compared to the length of main_str less the offset.</p>
6536
   * @param boolean $case_insensitivity [optional] <p>If case_insensitivity is TRUE, comparison is case
6537
   *                                    insensitive.</p>
6538
   *
6539
   * @return int <p>
6540
   *             <strong>&lt; 0</strong> if str1 is less than str2;<br>
6541
   *             <strong>&gt; 0</strong> if str1 is greater than str2,<br>
6542
   *             <strong>0</strong> if they are equal.
6543
   *             </p>
6544
   */
6545 1
  public static function substr_compare($str1, $str2, $offset = 0, $length = null, $case_insensitivity = false)
6546
  {
6547
    if (
6548
        $offset !== 0
6549 1
        ||
6550
        $length !== null
6551 1
    ) {
6552 1
      $str1Tmp = self::substr($str1, $offset, $length);
6553 1
      if ($str1Tmp === false) {
6554
        $str1Tmp = '';
6555
      }
6556 1
      $str1 = (string)$str1Tmp;
6557
6558 1
      $str2Tmp = self::substr($str2, 0, self::strlen($str1));
6559 1
      if ($str2Tmp === false) {
6560
        $str2Tmp = '';
6561
      }
6562 1
      $str2 = (string)$str2Tmp;
6563 1
    }
6564
6565 1
    if ($case_insensitivity === true) {
6566 1
      return self::strcasecmp($str1, $str2);
6567
    }
6568
6569 1
    return self::strcmp($str1, $str2);
6570
  }
6571
6572
  /**
6573
   * Count the number of substring occurrences.
6574
   *
6575
   * @link  http://php.net/manual/en/function.substr-count.php
6576
   *
6577
   * @param string  $haystack  <p>The string to search in.</p>
6578
   * @param string  $needle    <p>The substring to search for.</p>
6579
   * @param int     $offset    [optional] <p>The offset where to start counting.</p>
6580
   * @param int     $length    [optional] <p>
6581
   *                           The maximum length after the specified offset to search for the
6582
   *                           substring. It outputs a warning if the offset plus the length is
6583
   *                           greater than the haystack length.
6584
   *                           </p>
6585
   * @param string  $encoding  <p>Set the charset.</p>
6586
   * @param boolean $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
6587
   *
6588
   * @return int|false <p>This functions returns an integer or false if there isn't a string.</p>
6589
   */
6590 1
  public static function substr_count($haystack, $needle, $offset = 0, $length = null, $encoding = 'UTF-8', $cleanUtf8 = false)
6591
  {
6592
    // init
6593 1
    $haystack = (string)$haystack;
6594 1
    $needle = (string)$needle;
6595
6596 1
    if (!isset($haystack[0], $needle[0])) {
6597 1
      return false;
6598
    }
6599
6600 1
    if ($offset || $length !== null) {
6601
6602 1
      if ($length === null) {
6603 1
        $length = (int)self::strlen($haystack);
6604 1
      }
6605
6606 1
      $offset = (int)$offset;
6607 1
      $length = (int)$length;
6608
6609
      if (
6610
          (
6611
              $length !== 0
6612 1
              &&
6613
              $offset !== 0
6614 1
          )
6615 1
          &&
6616 1
          $length + $offset <= 0
6617 1
          &&
6618 1
          Bootup::is_php('7.1') === false // output from "substr_count()" have changed in PHP 7.1
6619 1
      ) {
6620 1
        return false;
6621
      }
6622
6623 1
      $haystackTmp = self::substr($haystack, $offset, $length, $encoding);
6624 1
      if ($haystackTmp === false) {
6625
        $haystackTmp = '';
6626
      }
6627 1
      $haystack = (string)$haystackTmp;
6628 1
    }
6629
6630 1
    if ($encoding !== 'UTF-8') {
6631 1
      $encoding = self::normalize_encoding($encoding, 'UTF-8');
6632 1
    }
6633
6634 1
    if ($cleanUtf8 === true) {
6635
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
6636
      // if invalid characters are found in $haystack before $needle
6637
      $needle = self::clean($needle);
6638
      $haystack = self::clean($haystack);
6639
    }
6640
6641 1
    if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
6642
      self::checkForSupport();
6643
    }
6644
6645 View Code Duplication
    if (
6646
        $encoding !== 'UTF-8'
6647 1
        &&
6648 1
        self::$SUPPORT['mbstring'] === false
6649 1
    ) {
6650
      trigger_error('UTF8::substr_count() without mbstring cannot handle "' . $encoding . '" encoding', E_USER_WARNING);
6651
    }
6652
6653 1
    if (self::$SUPPORT['mbstring'] === true) {
6654 1
      return \mb_substr_count($haystack, $needle, $encoding);
6655
    }
6656
6657
    preg_match_all('/' . preg_quote($needle, '/') . '/us', $haystack, $matches, PREG_SET_ORDER);
6658
6659
    return count($matches);
6660
  }
6661
6662
  /**
6663
   * Removes an prefix ($needle) from start of the string ($haystack), case insensitive.
6664
   *
6665
   * @param string $haystack <p>The string to search in.</p>
6666
   * @param string $needle   <p>The substring to search for.</p>
6667
   *
6668
   * @return string <p>Return the sub-string.</p>
6669
   */
6670 1 View Code Duplication
  public static function substr_ileft($haystack, $needle)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
6671
  {
6672
    // init
6673 1
    $haystack = (string)$haystack;
6674 1
    $needle = (string)$needle;
6675
6676 1
    if (!isset($haystack[0])) {
6677 1
      return '';
6678
    }
6679
6680 1
    if (!isset($needle[0])) {
6681 1
      return $haystack;
6682
    }
6683
6684 1
    if (self::str_istarts_with($haystack, $needle) === true) {
6685 1
      $haystackTmp = self::substr($haystack, self::strlen($needle));
6686 1
      if ($haystackTmp === false) {
6687
        $haystackTmp = '';
6688
      }
6689 1
      $haystack = (string)$haystackTmp;
6690 1
    }
6691
6692 1
    return $haystack;
6693
  }
6694
6695
  /**
6696
   * Removes an suffix ($needle) from end of the string ($haystack), case insensitive.
6697
   *
6698
   * @param string $haystack <p>The string to search in.</p>
6699
   * @param string $needle   <p>The substring to search for.</p>
6700
   *
6701
   * @return string <p>Return the sub-string.</p>
6702
   */
6703 1 View Code Duplication
  public static function substr_iright($haystack, $needle)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
6704
  {
6705
    // init
6706 1
    $haystack = (string)$haystack;
6707 1
    $needle = (string)$needle;
6708
6709 1
    if (!isset($haystack[0])) {
6710 1
      return '';
6711
    }
6712
6713 1
    if (!isset($needle[0])) {
6714 1
      return $haystack;
6715
    }
6716
6717 1
    if (self::str_iends_with($haystack, $needle) === true) {
6718 1
      $haystackTmp = self::substr($haystack, 0, self::strlen($haystack) - self::strlen($needle));
6719 1
      if ($haystackTmp === false) {
6720
        $haystackTmp = '';
6721
      }
6722 1
      $haystack = (string)$haystackTmp;
6723 1
    }
6724
6725 1
    return $haystack;
6726
  }
6727
6728
  /**
6729
   * Removes an prefix ($needle) from start of the string ($haystack).
6730
   *
6731
   * @param string $haystack <p>The string to search in.</p>
6732
   * @param string $needle   <p>The substring to search for.</p>
6733
   *
6734
   * @return string <p>Return the sub-string.</p>
6735
   */
6736 1 View Code Duplication
  public static function substr_left($haystack, $needle)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
6737
  {
6738
    // init
6739 1
    $haystack = (string)$haystack;
6740 1
    $needle = (string)$needle;
6741
6742 1
    if (!isset($haystack[0])) {
6743 1
      return '';
6744
    }
6745
6746 1
    if (!isset($needle[0])) {
6747 1
      return $haystack;
6748
    }
6749
6750 1
    if (self::str_starts_with($haystack, $needle) === true) {
6751 1
      $haystackTmp = self::substr($haystack, self::strlen($needle));
6752 1
      if ($haystackTmp === false) {
6753
        $haystackTmp = '';
6754
      }
6755 1
      $haystack = (string)$haystackTmp;
6756 1
    }
6757
6758 1
    return $haystack;
6759
  }
6760
6761
  /**
6762
   * Replace text within a portion of a string.
6763
   *
6764
   * source: https://gist.github.com/stemar/8287074
6765
   *
6766
   * @param string|string[] $str              <p>The input string or an array of stings.</p>
6767
   * @param string|string[] $replacement      <p>The replacement string or an array of stings.</p>
6768
   * @param int|int[]       $offset           <p>
6769
   *                                          If start is positive, the replacing will begin at the start'th offset
6770
   *                                          into string.
6771
   *                                          <br><br>
6772
   *                                          If start is negative, the replacing will begin at the start'th character
6773
   *                                          from the end of string.
6774
   *                                          </p>
6775
   * @param int|int[]|void  $length           [optional] <p>If given and is positive, it represents the length of the
6776
   *                                          portion of string which is to be replaced. If it is negative, it
6777
   *                                          represents the number of characters from the end of string at which to
6778
   *                                          stop replacing. If it is not given, then it will default to strlen(
6779
   *                                          string ); i.e. end the replacing at the end of string. Of course, if
6780
   *                                          length is zero then this function will have the effect of inserting
6781
   *                                          replacement into string at the given start offset.</p>
6782
   *
6783
   * @return string|string[] <p>The result string is returned. If string is an array then array is returned.</p>
6784
   */
6785 7
  public static function substr_replace($str, $replacement, $offset, $length = null)
6786
  {
6787 7
    if (is_array($str) === true) {
6788 1
      $num = count($str);
6789
6790
      // the replacement
6791 1
      if (is_array($replacement) === true) {
6792 1
        $replacement = array_slice($replacement, 0, $num);
6793 1
      } else {
6794 1
        $replacement = array_pad(array($replacement), $num, $replacement);
6795
      }
6796
6797
      // the offset
6798 1
      if (is_array($offset) === true) {
6799 1
        $offset = array_slice($offset, 0, $num);
6800 1
        foreach ($offset as &$valueTmp) {
6801 1
          if (!$valueTmp || (int)$valueTmp !== $valueTmp) {
6802 1
            $valueTmp = 0;
6803 1
          }
6804 1
        }
6805 1
        unset($valueTmp);
6806 1
      } else {
6807 1
        $offset = array_pad(array($offset), $num, $offset);
6808
      }
6809
6810
      // the length
6811 1
      if (null === $length) {
6812 1
        $length = array_fill(0, $num, 0);
6813 1
      } elseif (is_array($length) === true) {
6814 1
        $length = array_slice($length, 0, $num);
6815 1
        foreach ($length as &$valueTmpV2) {
6816 1
          if (!$valueTmpV2) {
6817
            $valueTmpV2 = 0;
6818
          } else {
6819 1
            if ((int)$valueTmpV2 !== $valueTmpV2) {
6820
              $valueTmpV2 = $num;
6821
            }
6822
          }
6823 1
        }
6824 1
        unset($valueTmpV2);
6825 1
      } else {
6826 1
        $length = array_pad(array($length), $num, $length);
6827
      }
6828
6829
      // recursive call
6830 1
      return array_map(array('\\voku\\helper\\UTF8', 'substr_replace'), $str, $replacement, $offset, $length);
0 ignored issues
show
Bug Best Practice introduced by
The return type of return array_map(array('...ent, $offset, $length); (array) is incompatible with the return type documented by voku\helper\UTF8::substr_replace of type string|string[].

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

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

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

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

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

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

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

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
6831
    }
6832
6833 7
    if (is_array($replacement) === true) {
6834 1
      if (count($replacement) > 0) {
6835 1
        $replacement = $replacement[0];
6836 1
      } else {
6837 1
        $replacement = '';
6838
      }
6839 1
    }
6840
6841
    // init
6842 7
    $str = (string)$str;
6843 7
    $replacement = (string)$replacement;
6844
6845 7
    if (!isset($str[0])) {
6846 1
      return $replacement;
6847
    }
6848
6849 6
    if (self::is_ascii($str)) {
6850 3
      return ($length === null) ?
6851 3
          substr_replace($str, $replacement, $offset) :
6852 3
          substr_replace($str, $replacement, $offset, $length);
6853
    }
6854
6855 5
    preg_match_all('/./us', $str, $smatches);
6856 5
    preg_match_all('/./us', $replacement, $rmatches);
6857
6858 5
    if ($length === null) {
6859 3
      $length = (int)self::strlen($str);
6860 3
    }
6861
6862 5
    array_splice($smatches[0], $offset, $length, $rmatches[0]);
6863
6864 5
    return implode('', $smatches[0]);
6865
  }
6866
6867
  /**
6868
   * Removes an suffix ($needle) from end of the string ($haystack).
6869
   *
6870
   * @param string $haystack <p>The string to search in.</p>
6871
   * @param string $needle   <p>The substring to search for.</p>
6872
   *
6873
   * @return string <p>Return the sub-string.</p>
6874
   */
6875 1 View Code Duplication
  public static function substr_right($haystack, $needle)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
6876
  {
6877 1
    $haystack = (string)$haystack;
6878 1
    $needle = (string)$needle;
6879
6880 1
    if (!isset($haystack[0])) {
6881 1
      return '';
6882
    }
6883
6884 1
    if (!isset($needle[0])) {
6885 1
      return $haystack;
6886
    }
6887
6888 1
    if (self::str_ends_with($haystack, $needle) === true) {
6889 1
      $haystackTmp = self::substr($haystack, 0, self::strlen($haystack) - self::strlen($needle));
6890 1
      if ($haystackTmp === false) {
6891
        $haystackTmp = '';
6892
      }
6893 1
      $haystack = (string)$haystackTmp;
6894 1
    }
6895
6896 1
    return $haystack;
6897
  }
6898
6899
  /**
6900
   * Returns a case swapped version of the string.
6901
   *
6902
   * @param string  $str       <p>The input string.</p>
6903
   * @param string  $encoding  [optional] <p>Default is UTF-8</p>
6904
   * @param boolean $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
6905
   *
6906
   * @return string <p>Each character's case swapped.</p>
6907
   */
6908 1
  public static function swapCase($str, $encoding = 'UTF-8', $cleanUtf8 = false)
6909
  {
6910 1
    $str = (string)$str;
6911
6912 1
    if (!isset($str[0])) {
6913 1
      return '';
6914
    }
6915
6916 1
    if ($encoding !== 'UTF-8') {
6917 1
      $encoding = self::normalize_encoding($encoding, 'UTF-8');
6918 1
    }
6919
6920 1
    if ($cleanUtf8 === true) {
6921
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
6922
      // if invalid characters are found in $haystack before $needle
6923 1
      $str = self::clean($str);
6924 1
    }
6925
6926 1
    $strSwappedCase = preg_replace_callback(
6927 1
        '/[\S]/u',
6928
        function ($match) use ($encoding) {
6929 1
          $marchToUpper = self::strtoupper($match[0], $encoding);
6930
6931 1
          if ($match[0] === $marchToUpper) {
6932 1
            return self::strtolower($match[0], $encoding);
6933
          }
6934
6935 1
          return $marchToUpper;
6936 1
        },
6937
        $str
6938 1
    );
6939
6940 1
    return $strSwappedCase;
6941
  }
6942
6943
  /**
6944
   * alias for "UTF8::to_ascii()"
6945
   *
6946
   * @see UTF8::to_ascii()
6947
   *
6948
   * @param string $s
6949
   * @param string $subst_chr
6950
   * @param bool   $strict
6951
   *
6952
   * @return string
6953
   *
6954
   * @deprecated <p>use "UTF8::to_ascii()"</p>
6955
   */
6956
  public static function toAscii($s, $subst_chr = '?', $strict = false)
6957
  {
6958
    return self::to_ascii($s, $subst_chr, $strict);
6959
  }
6960
6961
  /**
6962
   * alias for "UTF8::to_iso8859()"
6963
   *
6964
   * @see UTF8::to_iso8859()
6965
   *
6966
   * @param string $str
6967
   *
6968
   * @return string|string[]
6969
   *
6970
   * @deprecated <p>use "UTF8::to_iso8859()"</p>
6971
   */
6972
  public static function toIso8859($str)
6973
  {
6974
    return self::to_iso8859($str);
6975
  }
6976
6977
  /**
6978
   * alias for "UTF8::to_latin1()"
6979
   *
6980
   * @see UTF8::to_latin1()
6981
   *
6982
   * @param $str
6983
   *
6984
   * @return string
6985
   *
6986
   * @deprecated <p>use "UTF8::to_latin1()"</p>
6987
   */
6988
  public static function toLatin1($str)
6989
  {
6990
    return self::to_latin1($str);
6991
  }
6992
6993
  /**
6994
   * alias for "UTF8::to_utf8()"
6995
   *
6996
   * @see UTF8::to_utf8()
6997
   *
6998
   * @param string $str
6999
   *
7000
   * @return string
7001
   *
7002
   * @deprecated <p>use "UTF8::to_utf8()"</p>
7003
   */
7004
  public static function toUTF8($str)
7005
  {
7006
    return self::to_utf8($str);
7007
  }
7008
7009
  /**
7010
   * Convert a string into ASCII.
7011
   *
7012
   * @param string $str     <p>The input string.</p>
7013
   * @param string $unknown [optional] <p>Character use if character unknown. (default is ?)</p>
7014
   * @param bool   $strict  [optional] <p>Use "transliterator_transliterate()" from PHP-Intl | WARNING: bad
7015
   *                        performance</p>
7016
   *
7017
   * @return string
7018
   */
7019 21
  public static function to_ascii($str, $unknown = '?', $strict = false)
7020
  {
7021 21
    static $UTF8_TO_ASCII;
7022
7023
    // init
7024 21
    $str = (string)$str;
7025
7026 21
    if (!isset($str[0])) {
7027 4
      return '';
7028
    }
7029
7030
    // check if we only have ASCII, first (better performance)
7031 18
    if (self::is_ascii($str) === true) {
7032 6
      return $str;
7033
    }
7034
7035 13
    $str = self::clean($str, true, true, true);
7036
7037
    // check again, if we only have ASCII, now ...
7038 13
    if (self::is_ascii($str) === true) {
7039 7
      return $str;
7040
    }
7041
7042 7
    if ($strict === true) {
7043 1
      if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
7044
        self::checkForSupport();
7045
      }
7046
7047
      if (
7048 1
          self::$SUPPORT['intl'] === true
7049 1
          &&
7050 1
          Bootup::is_php('5.4') === true
7051 1
      ) {
7052
7053
        // HACK for issue from "transliterator_transliterate()"
7054 1
        $str = str_replace(
7055 1
            'ℌ',
7056 1
            'H',
7057
            $str
7058 1
        );
7059
7060 1
        $str = transliterator_transliterate('NFD; [:Nonspacing Mark:] Remove; NFC; Any-Latin; Latin-ASCII;', $str);
7061
7062
        // check again, if we only have ASCII, now ...
7063 1
        if (self::is_ascii($str) === true) {
7064 1
          return $str;
7065
        }
7066
7067 1
      }
7068 1
    }
7069
7070 7
    preg_match_all('/.{1}|[^\x00]{1,1}$/us', $str, $ar);
7071 7
    $chars = $ar[0];
7072 7
    $ord = null;
7073 7
    foreach ($chars as &$c) {
7074
7075 7
      $ordC0 = ord($c[0]);
7076
7077 7
      if ($ordC0 >= 0 && $ordC0 <= 127) {
7078 7
        continue;
7079
      }
7080
7081 7
      $ordC1 = ord($c[1]);
7082
7083
      // ASCII - next please
7084 7
      if ($ordC0 >= 192 && $ordC0 <= 223) {
7085 7
        $ord = ($ordC0 - 192) * 64 + ($ordC1 - 128);
7086 7
      }
7087
7088 7
      if ($ordC0 >= 224) {
7089 2
        $ordC2 = ord($c[2]);
7090
7091 2
        if ($ordC0 <= 239) {
7092 2
          $ord = ($ordC0 - 224) * 4096 + ($ordC1 - 128) * 64 + ($ordC2 - 128);
7093 2
        }
7094
7095 2
        if ($ordC0 >= 240) {
7096 1
          $ordC3 = ord($c[3]);
7097
7098 1
          if ($ordC0 <= 247) {
7099 1
            $ord = ($ordC0 - 240) * 262144 + ($ordC1 - 128) * 4096 + ($ordC2 - 128) * 64 + ($ordC3 - 128);
7100 1
          }
7101
7102 1
          if ($ordC0 >= 248) {
7103
            $ordC4 = ord($c[4]);
7104
7105 View Code Duplication
            if ($ordC0 <= 251) {
7106
              $ord = ($ordC0 - 248) * 16777216 + ($ordC1 - 128) * 262144 + ($ordC2 - 128) * 4096 + ($ordC3 - 128) * 64 + ($ordC4 - 128);
7107
            }
7108
7109
            if ($ordC0 >= 252) {
7110
              $ordC5 = ord($c[5]);
7111
7112 View Code Duplication
              if ($ordC0 <= 253) {
7113
                $ord = ($ordC0 - 252) * 1073741824 + ($ordC1 - 128) * 16777216 + ($ordC2 - 128) * 262144 + ($ordC3 - 128) * 4096 + ($ordC4 - 128) * 64 + ($ordC5 - 128);
7114
              }
7115
            }
7116
          }
7117 1
        }
7118 2
      }
7119
7120 7
      if ($ordC0 === 254 || $ordC0 === 255) {
7121
        $c = $unknown;
7122
        continue;
7123
      }
7124
7125 7
      if (null === $ord) {
7126
        $c = $unknown;
7127
        continue;
7128
      }
7129
7130 7
      $bank = $ord >> 8;
7131 7
      if (!isset($UTF8_TO_ASCII[$bank])) {
7132 3
        $UTF8_TO_ASCII[$bank] = self::getData(sprintf('x%02x', $bank));
7133 3
        if ($UTF8_TO_ASCII[$bank] === false) {
7134 1
          $UTF8_TO_ASCII[$bank] = array();
7135 1
        }
7136 3
      }
7137
7138 7
      $newchar = $ord & 255;
7139
7140 7
      if (isset($UTF8_TO_ASCII[$bank], $UTF8_TO_ASCII[$bank][$newchar])) {
7141
7142
        // keep for debugging
7143
        /*
7144
        echo "file: " . sprintf('x%02x', $bank) . "\n";
7145
        echo "char: " . $c . "\n";
7146
        echo "ord: " . $ord . "\n";
7147
        echo "newchar: " . $newchar . "\n";
7148
        echo "ascii: " . $UTF8_TO_ASCII[$bank][$newchar] . "\n";
7149
        echo "bank:" . $bank . "\n\n";
7150
        */
7151
7152 7
        $c = $UTF8_TO_ASCII[$bank][$newchar];
7153 7
      } else {
7154
7155
        // keep for debugging missing chars
7156
        /*
7157
        echo "file: " . sprintf('x%02x', $bank) . "\n";
7158
        echo "char: " . $c . "\n";
7159
        echo "ord: " . $ord . "\n";
7160
        echo "newchar: " . $newchar . "\n";
7161
        echo "bank:" . $bank . "\n\n";
7162
        */
7163
7164 1
        $c = $unknown;
7165
      }
7166 7
    }
7167
7168 7
    return implode('', $chars);
7169
  }
7170
7171
  /**
7172
   * Convert a string into "ISO-8859"-encoding (Latin-1).
7173
   *
7174
   * @param string|string[] $str
7175
   *
7176
   * @return string|string[]
7177
   */
7178 2
  public static function to_iso8859($str)
7179
  {
7180 2
    if (is_array($str) === true) {
7181
7182
      /** @noinspection ForeachSourceInspection */
7183 1
      foreach ($str as $k => $v) {
7184
        /** @noinspection AlterInForeachInspection */
7185
        /** @noinspection OffsetOperationsInspection */
7186 1
        $str[$k] = self::to_iso8859($v);
7187 1
      }
7188
7189 1
      return $str;
7190
    }
7191
7192 2
    $str = (string)$str;
7193
7194 2
    if (!isset($str[0])) {
7195 1
      return '';
7196
    }
7197
7198 2
    return self::utf8_decode($str);
7199
  }
7200
7201
  /**
7202
   * alias for "UTF8::to_iso8859()"
7203
   *
7204
   * @see UTF8::to_iso8859()
7205
   *
7206
   * @param string|string[] $str
7207
   *
7208
   * @return string|string[]
7209
   */
7210 1
  public static function to_latin1($str)
7211
  {
7212 1
    return self::to_iso8859($str);
7213
  }
7214
7215
  /**
7216
   * This function leaves UTF-8 characters alone, while converting almost all non-UTF8 to UTF8.
7217
   *
7218
   * <ul>
7219
   * <li>It decode UTF-8 codepoints and unicode escape sequences.</li>
7220
   * <li>It assumes that the encoding of the original string is either WINDOWS-1252 or ISO-8859.</li>
7221
   * <li>WARNING: It does not remove invalid UTF-8 characters, so you maybe need to use "UTF8::clean()" for this
7222
   * case.</li>
7223
   * </ul>
7224
   *
7225
   * @param string|string[] $str                    <p>Any string or array.</p>
7226
   * @param bool            $decodeHtmlEntityToUtf8 <p>Set to true, if you need to decode html-entities.</p>
7227
   *
7228
   * @return string|string[] <p>The UTF-8 encoded string.</p>
7229
   */
7230 20
  public static function to_utf8($str, $decodeHtmlEntityToUtf8 = false)
7231
  {
7232 20
    if (is_array($str) === true) {
7233
      /** @noinspection ForeachSourceInspection */
7234 2
      foreach ($str as $k => $v) {
7235
        /** @noinspection AlterInForeachInspection */
7236
        /** @noinspection OffsetOperationsInspection */
7237 2
        $str[$k] = self::to_utf8($v, $decodeHtmlEntityToUtf8);
7238 2
      }
7239
7240 2
      return $str;
7241
    }
7242
7243 20
    $str = (string)$str;
7244
7245 20
    if (!isset($str[0])) {
7246 3
      return $str;
7247
    }
7248
7249 20
    if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
7250
      self::checkForSupport();
7251
    }
7252
7253 20 View Code Duplication
    if (self::$SUPPORT['mbstring_func_overload'] === true) {
7254
      $max = \mb_strlen($str, '8BIT');
7255
    } else {
7256 20
      $max = strlen($str);
7257
    }
7258
7259 20
    $buf = '';
7260
7261
    /** @noinspection ForeachInvariantsInspection */
7262 20
    for ($i = 0; $i < $max; $i++) {
7263 20
      $c1 = $str[$i];
7264
7265 20
      if ($c1 >= "\xC0") { // should be converted to UTF8, if it's not UTF8 already
7266
7267 20
        if ($c1 <= "\xDF") { // looks like 2 bytes UTF8
7268
7269 18
          $c2 = $i + 1 >= $max ? "\x00" : $str[$i + 1];
7270
7271 18
          if ($c2 >= "\x80" && $c2 <= "\xBF") { // yeah, almost sure it's UTF8 already
7272 17
            $buf .= $c1 . $c2;
7273 17
            $i++;
7274 17
          } else { // not valid UTF8 - convert it
7275 6
            $buf .= self::to_utf8_convert($c1);
7276
          }
7277
7278 20
        } elseif ($c1 >= "\xE0" && $c1 <= "\xEF") { // looks like 3 bytes UTF8
7279
7280 19
          $c2 = $i + 1 >= $max ? "\x00" : $str[$i + 1];
7281 19
          $c3 = $i + 2 >= $max ? "\x00" : $str[$i + 2];
7282
7283 19
          if ($c2 >= "\x80" && $c2 <= "\xBF" && $c3 >= "\x80" && $c3 <= "\xBF") { // yeah, almost sure it's UTF8 already
7284 14
            $buf .= $c1 . $c2 . $c3;
7285 14
            $i += 2;
7286 14
          } else { // not valid UTF8 - convert it
7287 9
            $buf .= self::to_utf8_convert($c1);
7288
          }
7289
7290 20
        } elseif ($c1 >= "\xF0" && $c1 <= "\xF7") { // looks like 4 bytes UTF8
7291
7292 10
          $c2 = $i + 1 >= $max ? "\x00" : $str[$i + 1];
7293 10
          $c3 = $i + 2 >= $max ? "\x00" : $str[$i + 2];
7294 10
          $c4 = $i + 3 >= $max ? "\x00" : $str[$i + 3];
7295
7296 10
          if ($c2 >= "\x80" && $c2 <= "\xBF" && $c3 >= "\x80" && $c3 <= "\xBF" && $c4 >= "\x80" && $c4 <= "\xBF") { // yeah, almost sure it's UTF8 already
7297 4
            $buf .= $c1 . $c2 . $c3 . $c4;
7298 4
            $i += 3;
7299 4
          } else { // not valid UTF8 - convert it
7300 7
            $buf .= self::to_utf8_convert($c1);
7301
          }
7302
7303 10
        } else { // doesn't look like UTF8, but should be converted
7304 7
          $buf .= self::to_utf8_convert($c1);
7305
        }
7306
7307 20
      } elseif (($c1 & "\xC0") === "\x80") { // needs conversion
7308
7309 4
        $buf .= self::to_utf8_convert($c1);
7310
7311 4
      } else { // it doesn't need conversion
7312 18
        $buf .= $c1;
7313
      }
7314 20
    }
7315
7316
    // decode unicode escape sequences
7317 20
    $buf = preg_replace_callback(
7318 20
        '/\\\\u([0-9a-f]{4})/i',
7319 20
        function ($match) {
7320 4
          return \mb_convert_encoding(pack('H*', $match[1]), 'UTF-8', 'UCS-2BE');
7321 20
        },
7322
        $buf
7323 20
    );
7324
7325
    // decode UTF-8 codepoints
7326 20
    if ($decodeHtmlEntityToUtf8 === true) {
7327 1
      $buf = self::html_entity_decode($buf);
7328 1
    }
7329
7330 20
    return $buf;
7331
  }
7332
7333
  /**
7334
   * @param int $int
7335
   *
7336
   * @return string
7337
   */
7338 14
  private static function to_utf8_convert($int)
7339
  {
7340 14
    $buf = '';
7341
7342 14
    $ordC1 = ord($int);
7343 14
    if (isset(self::$WIN1252_TO_UTF8[$ordC1])) { // found in Windows-1252 special cases
7344 1
      $buf .= self::$WIN1252_TO_UTF8[$ordC1];
7345 1
    } else {
7346 14
      $cc1 = self::chr_and_parse_int($ordC1 / 64) | "\xC0";
7347 14
      $cc2 = ($int & "\x3F") | "\x80";
7348 14
      $buf .= $cc1 . $cc2;
7349
    }
7350
7351 14
    return $buf;
7352
  }
7353
7354
  /**
7355
   * Strip whitespace or other characters from beginning or end of a UTF-8 string.
7356
   *
7357
   * INFO: This is slower then "trim()"
7358
   *
7359
   * We can only use the original-function, if we use <= 7-Bit in the string / chars
7360
   * but the check for ACSII (7-Bit) cost more time, then we can safe here.
7361
   *
7362
   * @param string $str   <p>The string to be trimmed</p>
7363
   * @param string $chars [optional] <p>Optional characters to be stripped</p>
7364
   *
7365
   * @return string <p>The trimmed string.</p>
7366
   */
7367 26
  public static function trim($str = '', $chars = INF)
7368
  {
7369 26
    $str = (string)$str;
7370
7371 26
    if (!isset($str[0])) {
7372 5
      return '';
7373
    }
7374
7375
    // Info: http://nadeausoftware.com/articles/2007/9/php_tip_how_strip_punctuation_characters_web_page#Unicodecharactercategories
7376 22
    if ($chars === INF || !$chars) {
7377 6
      return preg_replace('/^[\pZ\pC]+|[\pZ\pC]+$/u', '', $str);
7378
    }
7379
7380 16
    return self::rtrim(self::ltrim($str, $chars), $chars);
7381
  }
7382
7383
  /**
7384
   * Makes string's first char uppercase.
7385
   *
7386
   * @param string  $str       <p>The input string.</p>
7387
   * @param string  $encoding  [optional] <p>Set the charset.</p>
7388
   * @param boolean $cleanUtf8 [optional] <p>Remove non UTF-8 chars from the string.</p>
7389
   *
7390
   * @return string <p>The resulting string</p>
7391
   */
7392 14
  public static function ucfirst($str, $encoding = 'UTF-8', $cleanUtf8 = false)
7393
  {
7394 14
    if ($cleanUtf8 === true) {
7395
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
7396
      // if invalid characters are found in $haystack before $needle
7397
      $str = self::clean($str);
7398
    }
7399
7400 14
    $strPartTwo = self::substr($str, 1, null, $encoding);
7401 14
    if ($strPartTwo === false) {
7402
      $strPartTwo = '';
7403
    }
7404
7405 14
    $strPartOne = self::strtoupper(
7406 14
        (string)self::substr($str, 0, 1, $encoding),
7407 14
        $encoding,
7408
        $cleanUtf8
7409 14
    );
7410
7411 14
    return $strPartOne . $strPartTwo;
7412
  }
7413
7414
  /**
7415
   * alias for "UTF8::ucfirst()"
7416
   *
7417
   * @see UTF8::ucfirst()
7418
   *
7419
   * @param string  $word
7420
   * @param string  $encoding
7421
   * @param boolean $cleanUtf8
7422
   *
7423
   * @return string
7424
   */
7425 1
  public static function ucword($word, $encoding = 'UTF-8', $cleanUtf8 = false)
7426
  {
7427 1
    return self::ucfirst($word, $encoding, $cleanUtf8);
7428
  }
7429
7430
  /**
7431
   * Uppercase for all words in the string.
7432
   *
7433
   * @param string   $str        <p>The input string.</p>
7434
   * @param string[] $exceptions [optional] <p>Exclusion for some words.</p>
7435
   * @param string   $charlist   [optional] <p>Additional chars that contains to words and do not start a new word.</p>
7436
   * @param string   $encoding   [optional] <p>Set the charset.</p>
7437
   * @param boolean  $cleanUtf8  [optional] <p>Remove non UTF-8 chars from the string.</p>
7438
   *
7439
   * @return string
7440
   */
7441 8
  public static function ucwords($str, $exceptions = array(), $charlist = '', $encoding = 'UTF-8', $cleanUtf8 = false)
7442
  {
7443 8
    if (!$str) {
7444 2
      return '';
7445
    }
7446
7447
    // INFO: mb_convert_case($str, MB_CASE_TITLE);
7448
    // -> MB_CASE_TITLE didn't only uppercase the first letter, it also lowercase all other letters
7449
7450 7
    if ($cleanUtf8 === true) {
7451
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
7452
      // if invalid characters are found in $haystack before $needle
7453
      $str = self::clean($str);
7454
    }
7455
7456 7
    $usePhpDefaultFunctions = !(bool)($charlist . implode('', $exceptions));
7457
7458
    if (
7459
        $usePhpDefaultFunctions === true
7460 7
        &&
7461 7
        self::is_ascii($str) === true
7462 7
    ) {
7463
      return ucwords($str);
7464
    }
7465
7466 7
    $words = self::str_to_words($str, $charlist);
7467 7
    $newWords = array();
7468
7469 7
    if (count($exceptions) > 0) {
7470 1
      $useExceptions = true;
7471 1
    } else {
7472 7
      $useExceptions = false;
7473
    }
7474
7475 7 View Code Duplication
    foreach ($words as $word) {
7476
7477 7
      if (!$word) {
7478 7
        continue;
7479
      }
7480
7481
      if (
7482
          $useExceptions === false
7483 7
          ||
7484
          (
7485
              $useExceptions === true
7486 1
              &&
7487 1
              !in_array($word, $exceptions, true)
7488 1
          )
7489 7
      ) {
7490 7
        $word = self::ucfirst($word, $encoding);
7491 7
      }
7492
7493 7
      $newWords[] = $word;
7494 7
    }
7495
7496 7
    return implode('', $newWords);
7497
  }
7498
7499
  /**
7500
   * Multi decode html entity & fix urlencoded-win1252-chars.
7501
   *
7502
   * e.g:
7503
   * 'test+test'                     => 'test test'
7504
   * 'D&#252;sseldorf'               => 'Düsseldorf'
7505
   * 'D%FCsseldorf'                  => 'Düsseldorf'
7506
   * 'D&#xFC;sseldorf'               => 'Düsseldorf'
7507
   * 'D%26%23xFC%3Bsseldorf'         => 'Düsseldorf'
7508
   * 'Düsseldorf'                   => 'Düsseldorf'
7509
   * 'D%C3%BCsseldorf'               => 'Düsseldorf'
7510
   * 'D%C3%83%C2%BCsseldorf'         => 'Düsseldorf'
7511
   * 'D%25C3%2583%25C2%25BCsseldorf' => 'Düsseldorf'
7512
   *
7513
   * @param string $str          <p>The input string.</p>
7514
   * @param bool   $multi_decode <p>Decode as often as possible.</p>
7515
   *
7516
   * @return string
7517
   */
7518 1 View Code Duplication
  public static function urldecode($str, $multi_decode = true)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
7519
  {
7520 1
    $str = (string)$str;
7521
7522 1
    if (!isset($str[0])) {
7523 1
      return '';
7524
    }
7525
7526 1
    $pattern = '/%u([0-9a-f]{3,4})/i';
7527 1
    if (preg_match($pattern, $str)) {
7528 1
      $str = preg_replace($pattern, '&#x\\1;', urldecode($str));
7529 1
    }
7530
7531 1
    $flags = Bootup::is_php('5.4') === true ? ENT_QUOTES | ENT_HTML5 : ENT_QUOTES;
7532
7533
    do {
7534 1
      $str_compare = $str;
7535
7536 1
      $str = self::fix_simple_utf8(
7537 1
          urldecode(
7538 1
              self::html_entity_decode(
7539 1
                  self::to_utf8($str),
0 ignored issues
show
Bug introduced by
It seems like self::to_utf8($str) targeting voku\helper\UTF8::to_utf8() can also be of type array; however, voku\helper\UTF8::html_entity_decode() does only seem to accept string, maybe add an additional type check?

This check looks at variables that are passed out again to other methods.

If the outgoing method call has stricter type requirements than the method itself, an issue is raised.

An additional type check may prevent trouble.

Loading history...
7540
                  $flags
7541 1
              )
7542 1
          )
7543 1
      );
7544
7545 1
    } while ($multi_decode === true && $str_compare !== $str);
7546
7547 1
    return (string)$str;
7548
  }
7549
7550
  /**
7551
   * Return a array with "urlencoded"-win1252 -> UTF-8
7552
   *
7553
   * @deprecated <p>use the "UTF8::urldecode()" function to decode a string</p>
7554
   *
7555
   * @return array
7556
   */
7557
  public static function urldecode_fix_win1252_chars()
7558
  {
7559
    return array(
7560
        '%20' => ' ',
7561
        '%21' => '!',
7562
        '%22' => '"',
7563
        '%23' => '#',
7564
        '%24' => '$',
7565
        '%25' => '%',
7566
        '%26' => '&',
7567
        '%27' => "'",
7568
        '%28' => '(',
7569
        '%29' => ')',
7570
        '%2A' => '*',
7571
        '%2B' => '+',
7572
        '%2C' => ',',
7573
        '%2D' => '-',
7574
        '%2E' => '.',
7575
        '%2F' => '/',
7576
        '%30' => '0',
7577
        '%31' => '1',
7578
        '%32' => '2',
7579
        '%33' => '3',
7580
        '%34' => '4',
7581
        '%35' => '5',
7582
        '%36' => '6',
7583
        '%37' => '7',
7584
        '%38' => '8',
7585
        '%39' => '9',
7586
        '%3A' => ':',
7587
        '%3B' => ';',
7588
        '%3C' => '<',
7589
        '%3D' => '=',
7590
        '%3E' => '>',
7591
        '%3F' => '?',
7592
        '%40' => '@',
7593
        '%41' => 'A',
7594
        '%42' => 'B',
7595
        '%43' => 'C',
7596
        '%44' => 'D',
7597
        '%45' => 'E',
7598
        '%46' => 'F',
7599
        '%47' => 'G',
7600
        '%48' => 'H',
7601
        '%49' => 'I',
7602
        '%4A' => 'J',
7603
        '%4B' => 'K',
7604
        '%4C' => 'L',
7605
        '%4D' => 'M',
7606
        '%4E' => 'N',
7607
        '%4F' => 'O',
7608
        '%50' => 'P',
7609
        '%51' => 'Q',
7610
        '%52' => 'R',
7611
        '%53' => 'S',
7612
        '%54' => 'T',
7613
        '%55' => 'U',
7614
        '%56' => 'V',
7615
        '%57' => 'W',
7616
        '%58' => 'X',
7617
        '%59' => 'Y',
7618
        '%5A' => 'Z',
7619
        '%5B' => '[',
7620
        '%5C' => '\\',
7621
        '%5D' => ']',
7622
        '%5E' => '^',
7623
        '%5F' => '_',
7624
        '%60' => '`',
7625
        '%61' => 'a',
7626
        '%62' => 'b',
7627
        '%63' => 'c',
7628
        '%64' => 'd',
7629
        '%65' => 'e',
7630
        '%66' => 'f',
7631
        '%67' => 'g',
7632
        '%68' => 'h',
7633
        '%69' => 'i',
7634
        '%6A' => 'j',
7635
        '%6B' => 'k',
7636
        '%6C' => 'l',
7637
        '%6D' => 'm',
7638
        '%6E' => 'n',
7639
        '%6F' => 'o',
7640
        '%70' => 'p',
7641
        '%71' => 'q',
7642
        '%72' => 'r',
7643
        '%73' => 's',
7644
        '%74' => 't',
7645
        '%75' => 'u',
7646
        '%76' => 'v',
7647
        '%77' => 'w',
7648
        '%78' => 'x',
7649
        '%79' => 'y',
7650
        '%7A' => 'z',
7651
        '%7B' => '{',
7652
        '%7C' => '|',
7653
        '%7D' => '}',
7654
        '%7E' => '~',
7655
        '%7F' => '',
7656
        '%80' => '`',
7657
        '%81' => '',
7658
        '%82' => '‚',
7659
        '%83' => 'ƒ',
7660
        '%84' => '„',
7661
        '%85' => '…',
7662
        '%86' => '†',
7663
        '%87' => '‡',
7664
        '%88' => 'ˆ',
7665
        '%89' => '‰',
7666
        '%8A' => 'Š',
7667
        '%8B' => '‹',
7668
        '%8C' => 'Œ',
7669
        '%8D' => '',
7670
        '%8E' => 'Ž',
7671
        '%8F' => '',
7672
        '%90' => '',
7673
        '%91' => '‘',
7674
        '%92' => '’',
7675
        '%93' => '“',
7676
        '%94' => '”',
7677
        '%95' => '•',
7678
        '%96' => '–',
7679
        '%97' => '—',
7680
        '%98' => '˜',
7681
        '%99' => '™',
7682
        '%9A' => 'š',
7683
        '%9B' => '›',
7684
        '%9C' => 'œ',
7685
        '%9D' => '',
7686
        '%9E' => 'ž',
7687
        '%9F' => 'Ÿ',
7688
        '%A0' => '',
7689
        '%A1' => '¡',
7690
        '%A2' => '¢',
7691
        '%A3' => '£',
7692
        '%A4' => '¤',
7693
        '%A5' => '¥',
7694
        '%A6' => '¦',
7695
        '%A7' => '§',
7696
        '%A8' => '¨',
7697
        '%A9' => '©',
7698
        '%AA' => 'ª',
7699
        '%AB' => '«',
7700
        '%AC' => '¬',
7701
        '%AD' => '',
7702
        '%AE' => '®',
7703
        '%AF' => '¯',
7704
        '%B0' => '°',
7705
        '%B1' => '±',
7706
        '%B2' => '²',
7707
        '%B3' => '³',
7708
        '%B4' => '´',
7709
        '%B5' => 'µ',
7710
        '%B6' => '¶',
7711
        '%B7' => '·',
7712
        '%B8' => '¸',
7713
        '%B9' => '¹',
7714
        '%BA' => 'º',
7715
        '%BB' => '»',
7716
        '%BC' => '¼',
7717
        '%BD' => '½',
7718
        '%BE' => '¾',
7719
        '%BF' => '¿',
7720
        '%C0' => 'À',
7721
        '%C1' => 'Á',
7722
        '%C2' => 'Â',
7723
        '%C3' => 'Ã',
7724
        '%C4' => 'Ä',
7725
        '%C5' => 'Å',
7726
        '%C6' => 'Æ',
7727
        '%C7' => 'Ç',
7728
        '%C8' => 'È',
7729
        '%C9' => 'É',
7730
        '%CA' => 'Ê',
7731
        '%CB' => 'Ë',
7732
        '%CC' => 'Ì',
7733
        '%CD' => 'Í',
7734
        '%CE' => 'Î',
7735
        '%CF' => 'Ï',
7736
        '%D0' => 'Ð',
7737
        '%D1' => 'Ñ',
7738
        '%D2' => 'Ò',
7739
        '%D3' => 'Ó',
7740
        '%D4' => 'Ô',
7741
        '%D5' => 'Õ',
7742
        '%D6' => 'Ö',
7743
        '%D7' => '×',
7744
        '%D8' => 'Ø',
7745
        '%D9' => 'Ù',
7746
        '%DA' => 'Ú',
7747
        '%DB' => 'Û',
7748
        '%DC' => 'Ü',
7749
        '%DD' => 'Ý',
7750
        '%DE' => 'Þ',
7751
        '%DF' => 'ß',
7752
        '%E0' => 'à',
7753
        '%E1' => 'á',
7754
        '%E2' => 'â',
7755
        '%E3' => 'ã',
7756
        '%E4' => 'ä',
7757
        '%E5' => 'å',
7758
        '%E6' => 'æ',
7759
        '%E7' => 'ç',
7760
        '%E8' => 'è',
7761
        '%E9' => 'é',
7762
        '%EA' => 'ê',
7763
        '%EB' => 'ë',
7764
        '%EC' => 'ì',
7765
        '%ED' => 'í',
7766
        '%EE' => 'î',
7767
        '%EF' => 'ï',
7768
        '%F0' => 'ð',
7769
        '%F1' => 'ñ',
7770
        '%F2' => 'ò',
7771
        '%F3' => 'ó',
7772
        '%F4' => 'ô',
7773
        '%F5' => 'õ',
7774
        '%F6' => 'ö',
7775
        '%F7' => '÷',
7776
        '%F8' => 'ø',
7777
        '%F9' => 'ù',
7778
        '%FA' => 'ú',
7779
        '%FB' => 'û',
7780
        '%FC' => 'ü',
7781
        '%FD' => 'ý',
7782
        '%FE' => 'þ',
7783
        '%FF' => 'ÿ',
7784
    );
7785
  }
7786
7787
  /**
7788
   * Decodes an UTF-8 string to ISO-8859-1.
7789
   *
7790
   * @param string $str <p>The input string.</p>
7791
   *
7792
   * @return string
7793
   */
7794 6
  public static function utf8_decode($str)
7795
  {
7796
    // init
7797 6
    $str = (string)$str;
7798
7799 6
    if (!isset($str[0])) {
7800 3
      return '';
7801
    }
7802
7803 6
    $str = (string)self::to_utf8($str);
7804
7805 6
    static $UTF8_TO_WIN1252_KEYS_CACHE = null;
7806 6
    static $UTF8_TO_WIN1252_VALUES_CACHE = null;
7807
7808 6
    if ($UTF8_TO_WIN1252_KEYS_CACHE === null) {
7809 1
      $UTF8_TO_WIN1252_KEYS_CACHE = array_keys(self::$UTF8_TO_WIN1252);
7810 1
      $UTF8_TO_WIN1252_VALUES_CACHE = array_values(self::$UTF8_TO_WIN1252);
7811 1
    }
7812
7813
    /** @noinspection PhpInternalEntityUsedInspection */
7814 6
    $str = str_replace($UTF8_TO_WIN1252_KEYS_CACHE, $UTF8_TO_WIN1252_VALUES_CACHE, $str);
7815
7816 6
    if (!isset(self::$SUPPORT['already_checked_via_portable_utf8'])) {
7817
      self::checkForSupport();
7818
    }
7819
7820 6 View Code Duplication
    if (self::$SUPPORT['mbstring_func_overload'] === true) {
7821
      $len = \mb_strlen($str, '8BIT');
7822
    } else {
7823 6
      $len = strlen($str);
7824
    }
7825
7826
    /** @noinspection ForeachInvariantsInspection */
7827 6
    for ($i = 0, $j = 0; $i < $len; ++$i, ++$j) {
7828 6
      switch ($str[$i] & "\xF0") {
7829 6
        case "\xC0":
7830 6
        case "\xD0":
7831 6
          $c = (ord($str[$i] & "\x1F") << 6) | ord($str[++$i] & "\x3F");
7832 6
          $str[$j] = $c < 256 ? self::chr_and_parse_int($c) : '?';
7833 6
          break;
7834
7835
        /** @noinspection PhpMissingBreakStatementInspection */
7836 6
        case "\xF0":
0 ignored issues
show
Coding Style introduced by
There must be a comment when fall-through is intentional in a non-empty case body
Loading history...
7837
          ++$i;
7838 6
        case "\xE0":
7839 4
          $str[$j] = '?';
7840 4
          $i += 2;
7841 4
          break;
7842
7843 6
        default:
7844 6
          $str[$j] = $str[$i];
7845 6
      }
7846 6
    }
7847
7848 6
    return (string)self::substr($str, 0, $j, '8BIT');
7849
  }
7850
7851
  /**
7852
   * Encodes an ISO-8859-1 string to UTF-8.
7853
   *
7854
   * @param string $str <p>The input string.</p>
7855
   *
7856
   * @return string
7857
   */
7858 7
  public static function utf8_encode($str)
7859
  {
7860
    // init
7861 7
    $str = (string)$str;
7862
7863 7
    if (!isset($str[0])) {
7864 7
      return '';
7865
    }
7866
7867 7
    $strTmp = \utf8_encode($str);
7868 7
    if ($strTmp === false) {
7869
      return '';
7870
    }
7871
7872 7
    $str = (string)$strTmp;
7873 7
    if (false === strpos($str, "\xC2")) {
7874 3
      return $str;
7875
    }
7876
7877 6
    static $CP1252_TO_UTF8_KEYS_CACHE = null;
7878 6
    static $CP1252_TO_UTF8_VALUES_CACHE = null;
7879
7880 6
    if ($CP1252_TO_UTF8_KEYS_CACHE === null) {
7881 1
      $CP1252_TO_UTF8_KEYS_CACHE = array_keys(self::$CP1252_TO_UTF8);
7882 1
      $CP1252_TO_UTF8_VALUES_CACHE = array_values(self::$CP1252_TO_UTF8);
7883 1
    }
7884
7885 6
    return str_replace($CP1252_TO_UTF8_KEYS_CACHE, $CP1252_TO_UTF8_VALUES_CACHE, $str);
7886
  }
7887
7888
  /**
7889
   * fix -> utf8-win1252 chars
7890
   *
7891
   * @param string $str <p>The input string.</p>
7892
   *
7893
   * @return string
7894
   *
7895
   * @deprecated <p>use "UTF8::fix_simple_utf8()"</p>
7896
   */
7897
  public static function utf8_fix_win1252_chars($str)
7898
  {
7899
    return self::fix_simple_utf8($str);
7900
  }
7901
7902
  /**
7903
   * Returns an array with all utf8 whitespace characters.
7904
   *
7905
   * @see   : http://www.bogofilter.org/pipermail/bogofilter/2003-March/001889.html
7906
   *
7907
   * @author: Derek E. [email protected]
7908
   *
7909
   * @return array <p>
7910
   *               An array with all known whitespace characters as values and the type of whitespace as keys
7911
   *               as defined in above URL.
7912
   *               </p>
7913
   */
7914 1
  public static function whitespace_table()
7915
  {
7916 1
    return self::$WHITESPACE_TABLE;
7917
  }
7918
7919
  /**
7920
   * Limit the number of words in a string.
7921
   *
7922
   * @param string $str      <p>The input string.</p>
7923
   * @param int    $limit    <p>The limit of words as integer.</p>
7924
   * @param string $strAddOn <p>Replacement for the striped string.</p>
7925
   *
7926
   * @return string
7927
   */
7928 1
  public static function words_limit($str, $limit = 100, $strAddOn = '...')
7929
  {
7930 1
    $str = (string)$str;
7931
7932 1
    if (!isset($str[0])) {
7933 1
      return '';
7934
    }
7935
7936
    // init
7937 1
    $limit = (int)$limit;
7938
7939 1
    if ($limit < 1) {
7940 1
      return '';
7941
    }
7942
7943 1
    preg_match('/^\s*+(?:\S++\s*+){1,' . $limit . '}/u', $str, $matches);
7944
7945
    if (
7946 1
        !isset($matches[0])
7947 1
        ||
7948 1
        self::strlen($str) === self::strlen($matches[0])
7949 1
    ) {
7950 1
      return $str;
7951
    }
7952
7953 1
    return self::rtrim($matches[0]) . $strAddOn;
7954
  }
7955
7956
  /**
7957
   * Wraps a string to a given number of characters
7958
   *
7959
   * @link  http://php.net/manual/en/function.wordwrap.php
7960
   *
7961
   * @param string $str   <p>The input string.</p>
7962
   * @param int    $width [optional] <p>The column width.</p>
7963
   * @param string $break [optional] <p>The line is broken using the optional break parameter.</p>
7964
   * @param bool   $cut   [optional] <p>
7965
   *                      If the cut is set to true, the string is
7966
   *                      always wrapped at or before the specified width. So if you have
7967
   *                      a word that is larger than the given width, it is broken apart.
7968
   *                      </p>
7969
   *
7970
   * @return string <p>The given string wrapped at the specified column.</p>
7971
   */
7972 10
  public static function wordwrap($str, $width = 75, $break = "\n", $cut = false)
7973
  {
7974 10
    $str = (string)$str;
7975 10
    $break = (string)$break;
7976
7977 10
    if (!isset($str[0], $break[0])) {
7978 3
      return '';
7979
    }
7980
7981 8
    $w = '';
7982 8
    $strSplit = explode($break, $str);
7983 8
    $count = count($strSplit);
7984
7985 8
    $chars = array();
7986
    /** @noinspection ForeachInvariantsInspection */
7987 8
    for ($i = 0; $i < $count; ++$i) {
7988
7989 8
      if ($i) {
7990 1
        $chars[] = $break;
7991 1
        $w .= '#';
7992 1
      }
7993
7994 8
      $c = $strSplit[$i];
7995 8
      unset($strSplit[$i]);
7996
7997 8
      foreach (self::split($c) as $c) {
7998 8
        $chars[] = $c;
7999 8
        $w .= ' ' === $c ? ' ' : '?';
8000 8
      }
8001 8
    }
8002
8003 8
    $strReturn = '';
8004 8
    $j = 0;
8005 8
    $b = $i = -1;
8006 8
    $w = wordwrap($w, $width, '#', $cut);
8007
8008 8
    while (false !== $b = self::strpos($w, '#', $b + 1)) {
8009 6
      for (++$i; $i < $b; ++$i) {
8010 6
        $strReturn .= $chars[$j];
8011 6
        unset($chars[$j++]);
8012 6
      }
8013
8014 6
      if ($break === $chars[$j] || ' ' === $chars[$j]) {
8015 3
        unset($chars[$j++]);
8016 3
      }
8017
8018 6
      $strReturn .= $break;
8019 6
    }
8020
8021 8
    return $strReturn . implode('', $chars);
8022
  }
8023
8024
  /**
8025
   * Returns an array of Unicode White Space characters.
8026
   *
8027
   * @return array <p>An array with numeric code point as key and White Space Character as value.</p>
8028
   */
8029 1
  public static function ws()
8030
  {
8031 1
    return self::$WHITESPACE;
8032
  }
8033
8034
}
8035