Completed
Push — master ( 2a1fe1...ef87f1 )
by Lars
09:18
created

UTF8::strstr()   B

Complexity

Conditions 5
Paths 8

Size

Total Lines 23
Code Lines 12

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 7
CRAP Score 5

Importance

Changes 2
Bugs 1 Features 1
Metric Value
c 2
b 1
f 1
dl 0
loc 23
ccs 7
cts 7
cp 1
rs 8.5906
cc 5
eloc 12
nc 8
nop 5
crap 5
1
<?php
2
3
namespace voku\helper;
4
5
use Symfony\Polyfill\Intl\Grapheme\Grapheme;
6
use Symfony\Polyfill\Xml\Xml;
7
8
/**
9
 * UTF8-Helper-Class
10
 *
11
 * @package voku\helper
12
 */
13
final class UTF8
14
{
15
  /**
16
   * @var array
17
   */
18
  private static $win1252ToUtf8 = array(
19
      128 => "\xe2\x82\xac", // EURO SIGN
20
      130 => "\xe2\x80\x9a", // SINGLE LOW-9 QUOTATION MARK
21
      131 => "\xc6\x92", // LATIN SMALL LETTER F WITH HOOK
22
      132 => "\xe2\x80\x9e", // DOUBLE LOW-9 QUOTATION MARK
23
      133 => "\xe2\x80\xa6", // HORIZONTAL ELLIPSIS
24
      134 => "\xe2\x80\xa0", // DAGGER
25
      135 => "\xe2\x80\xa1", // DOUBLE DAGGER
26
      136 => "\xcb\x86", // MODIFIER LETTER CIRCUMFLEX ACCENT
27
      137 => "\xe2\x80\xb0", // PER MILLE SIGN
28
      138 => "\xc5\xa0", // LATIN CAPITAL LETTER S WITH CARON
29
      139 => "\xe2\x80\xb9", // SINGLE LEFT-POINTING ANGLE QUOTE
30
      140 => "\xc5\x92", // LATIN CAPITAL LIGATURE OE
31
      142 => "\xc5\xbd", // LATIN CAPITAL LETTER Z WITH CARON
32
      145 => "\xe2\x80\x98", // LEFT SINGLE QUOTATION MARK
33
      146 => "\xe2\x80\x99", // RIGHT SINGLE QUOTATION MARK
34
      147 => "\xe2\x80\x9c", // LEFT DOUBLE QUOTATION MARK
35
      148 => "\xe2\x80\x9d", // RIGHT DOUBLE QUOTATION MARK
36
      149 => "\xe2\x80\xa2", // BULLET
37
      150 => "\xe2\x80\x93", // EN DASH
38
      151 => "\xe2\x80\x94", // EM DASH
39
      152 => "\xcb\x9c", // SMALL TILDE
40
      153 => "\xe2\x84\xa2", // TRADE MARK SIGN
41
      154 => "\xc5\xa1", // LATIN SMALL LETTER S WITH CARON
42
      155 => "\xe2\x80\xba", // SINGLE RIGHT-POINTING ANGLE QUOTE
43
      156 => "\xc5\x93", // LATIN SMALL LIGATURE OE
44
      158 => "\xc5\xbe", // LATIN SMALL LETTER Z WITH CARON
45
      159 => "\xc5\xb8", // LATIN CAPITAL LETTER Y WITH DIAERESIS
46
  );
47
48
  /**
49
   * @var array
50
   */
51
  private static $cp1252ToUtf8 = array(
52
      '€' => '€',
53
      '‚' => '‚',
54
      'ƒ' => 'ƒ',
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
   * Bom => Byte-Length
83
   *
84
   * INFO: https://en.wikipedia.org/wiki/Byte_order_mark
85
   *
86
   * @var array
87
   */
88
  private static $bom = array(
89
      "\xef\xbb\xbf"     => 3, // UTF-8 BOM
90
      ''              => 6, // UTF-8 BOM as "WINDOWS-1252" (one char has [maybe] more then one byte ...)
91
      "\x00\x00\xfe\xff" => 4, // UTF-32 (BE) BOM
92
      "\xff\xfe\x00\x00" => 4, // UTF-32 (LE) BOM
93
      "\xfe\xff"         => 2, // UTF-16 (BE) BOM
94
      'þÿ'               => 4, // UTF-16 (BE) BOM as "WINDOWS-1252"
0 ignored issues
show
Unused Code Comprehensibility introduced by
36% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
95
      "\xff\xfe"         => 2, // UTF-16 (LE) BOM
96
      'ÿþ'               => 4, // UTF-16 (LE) BOM as "WINDOWS-1252"
0 ignored issues
show
Unused Code Comprehensibility introduced by
36% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

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

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

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
1233
        &&
1234
        (
1235 1
            $force === true
1236
            ||
1237
            $encodingDetected !== $encoding
1238 2
        )
1239 1
    ) {
1240
1241
      if (
1242 2
          $encoding === 'UTF-8'
1243 2
          &&
1244 2
          (
1245
              $force === true
1246 2
              || $encodingDetected === 'UTF-8'
1247
              || $encodingDetected === 'WINDOWS-1252'
1248 2
              || $encodingDetected === 'ISO-8859-1'
1249 2
          )
1250
      ) {
1251
        return self::to_utf8($str);
1252
      }
1253 1
1254
      if (
1255
          $encoding === 'ISO-8859-1'
1256
          &&
1257
          (
1258
              $force === true
1259
              || $encodingDetected === 'ISO-8859-1'
1260
              || $encodingDetected === 'UTF-8'
1261
          )
1262
      ) {
1263
        return self::to_iso8859($str);
1264
      }
1265
1266
      $strEncoded = \mb_convert_encoding(
1267
          $str,
1268
          $encoding,
1269
          $encodingDetected
1270
      );
1271
1272
      if ($strEncoded) {
1273
        return $strEncoded;
1274
      }
1275
    }
1276
1277
    return $str;
1278
  }
1279
1280
  /**
1281
   * Reads entire file into a string.
1282
   *
1283
   * WARNING: do not use UTF-8 Option ($convertToUtf8) for binary-files (e.g.: images) !!!
1284
   *
1285
   * @link http://php.net/manual/en/function.file-get-contents.php
1286
   *
1287
   * @param string        $filename      <p>
1288
   *                                     Name of the file to read.
1289
   *                                     </p>
1290
   * @param int|null      $flags         [optional] <p>
1291
   *                                     Prior to PHP 6, this parameter is called
1292
   *                                     use_include_path and is a bool.
1293
   *                                     As of PHP 5 the FILE_USE_INCLUDE_PATH can be used
1294
   *                                     to trigger include path
1295
   *                                     search.
1296
   *                                     </p>
1297
   *                                     <p>
1298
   *                                     The value of flags can be any combination of
1299
   *                                     the following flags (with some restrictions), joined with the
1300
   *                                     binary OR (|)
1301
   *                                     operator.
1302
   *                                     </p>
1303
   *                                     <p>
1304
   *                                     <table>
1305
   *                                     Available flags
1306
   *                                     <tr valign="top">
1307
   *                                     <td>Flag</td>
1308
   *                                     <td>Description</td>
1309
   *                                     </tr>
1310
   *                                     <tr valign="top">
1311
   *                                     <td>
1312
   *                                     FILE_USE_INCLUDE_PATH
1313
   *                                     </td>
1314
   *                                     <td>
1315
   *                                     Search for filename in the include directory.
1316
   *                                     See include_path for more
1317
   *                                     information.
1318
   *                                     </td>
1319
   *                                     </tr>
1320
   *                                     <tr valign="top">
1321
   *                                     <td>
1322
   *                                     FILE_TEXT
1323
   *                                     </td>
1324
   *                                     <td>
1325
   *                                     As of PHP 6, the default encoding of the read
1326
   *                                     data is UTF-8. You can specify a different encoding by creating a
1327
   *                                     custom context or by changing the default using
1328
   *                                     stream_default_encoding. This flag cannot be
1329
   *                                     used with FILE_BINARY.
1330
   *                                     </td>
1331
   *                                     </tr>
1332
   *                                     <tr valign="top">
1333
   *                                     <td>
1334
   *                                     FILE_BINARY
1335
   *                                     </td>
1336
   *                                     <td>
1337
   *                                     With this flag, the file is read in binary mode. This is the default
1338 2
   *                                     setting and cannot be used with FILE_TEXT.
1339
   *                                     </td>
1340
   *                                     </tr>
1341 2
   *                                     </table>
1342 2
   *                                     </p>
1343
   * @param resource|null $context       [optional] <p>
1344 2
   *                                     A valid context resource created with
1345 2
   *                                     stream_context_create. If you don't need to use a
1346
   *                                     custom context, you can skip this parameter by &null;.
1347
   *                                     </p>
1348
   * @param int|null      $offset        [optional] <p>
1349 2
   *                                     The offset where the reading starts.
1350 2
   *                                     </p>
1351
   * @param int|null      $maxlen        [optional] <p>
1352 2
   *                                     Maximum length of data read. The default is to read until end
1353 2
   *                                     of file is reached.
1354
   *                                     </p>
1355 2
   * @param int           $timeout       <p>The time in seconds for the timeout.</p>
1356 1
   *
1357 1
   * @param boolean       $convertToUtf8 <strong>WARNING!!!</strong> <p>Maybe you can't use this option for e.g. images
1358 2
   *                                     or pdf, because they used non default utf-8 chars</p>
1359
   *
1360
   * @return string <p>The function returns the read data or false on failure.</p>
1361
   */
1362 2
  public static function file_get_contents($filename, $flags = null, $context = null, $offset = null, $maxlen = null, $timeout = 10, $convertToUtf8 = true)
1363 1
  {
1364
    // init
1365
    $timeout = (int)$timeout;
1366 1
    $filename = filter_var($filename, FILTER_SANITIZE_STRING);
1367 1
1368 1
    if ($timeout && $context === null) {
1369 1
      $context = stream_context_create(
1370
          array(
1371 1
              'http' =>
1372
                  array(
1373
                      'timeout' => $timeout,
1374
                  ),
1375
          )
1376
      );
1377
    }
1378
1379
    if (is_int($maxlen)) {
1380
      $data = file_get_contents($filename, $flags, $context, $offset, $maxlen);
1381 1
    } else {
1382
      $data = file_get_contents($filename, $flags, $context, $offset);
1383 1
    }
1384
1385
    // return false on error
1386
    if ($data === false) {
1387
      return false;
1388
    }
1389
1390
    if ($convertToUtf8 === true) {
1391
      $data = self::encode('UTF-8', $data, false);
1392
      $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...
1393
    }
1394
1395 9
    return $data;
1396
  }
1397 9
1398 9
  /**
1399 3
   * Checks if a file starts with BOM (Byte Order Mark) character.
1400
   *
1401 3
   * @param string $file_path <p>Path to a valid file.</p>
1402 3
   *
1403 3
   * @return bool <p><strong>true</strong> if the file has BOM at the start, <strong>false</strong> otherwise.</>
1404 9
   */
1405 2
  public static function file_has_bom($file_path)
1406 2
  {
1407 2
    return self::string_has_bom(file_get_contents($file_path));
1408 2
  }
1409 9
1410 8
  /**
1411
   * Normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
1412 2
   *
1413 2
   * @param mixed  $var
1414 8
   * @param int    $normalization_form
1415 8
   * @param string $leading_combining
1416 6
   *
1417 6
   * @return mixed
1418 6
   */
1419
  public static function filter($var, $normalization_form = 4 /* n::NFC */, $leading_combining = '◌')
1420 6
  {
1421 3
    switch (gettype($var)) {
1422 3 View Code Duplication
      case 'array':
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
1423 5
        foreach ($var as $k => $v) {
1424
          /** @noinspection AlterInForeachInspection */
1425
          $var[$k] = self::filter($v, $normalization_form, $leading_combining);
1426
        }
1427 8
        break;
1428 View Code Duplication
      case 'object':
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
1429
        foreach ($var as $k => $v) {
1430 2
          $var->{$k} = self::filter($v, $normalization_form, $leading_combining);
1431 2
        }
1432 8
        break;
1433 8
      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...
1434 9
1435
        if (false !== strpos($var, "\r")) {
1436 9
          // Workaround https://bugs.php.net/65732
1437
          $var = str_replace(array("\r\n", "\r"), "\n", $var);
1438
        }
1439
1440
        if (self::is_ascii($var) === false) {
1441
1442
          if (\Normalizer::isNormalized($var, $normalization_form)) {
1443
            $n = '-';
1444
          } else {
1445
            $n = \Normalizer::normalize($var, $normalization_form);
1446
1447
            if (isset($n[0])) {
1448
              $var = $n;
1449
            } else {
1450
              $var = self::encode('UTF-8', $var);
1451
            }
1452
          }
1453
1454
          if (
1455
              $var[0] >= "\x80" && isset($n[0], $leading_combining[0])
1456
              &&
1457
              preg_match('/^\p{Mn}/u', $var)
1458
          ) {
1459
            // Prevent leading combining chars
1460
            // for NFC-safe concatenations.
1461
            $var = $leading_combining . $var;
1462
          }
1463
        }
1464
        break;
1465
    }
1466
1467
    return $var;
1468
  }
1469
1470
  /**
1471
   * "filter_input()"-wrapper with normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
1472
   *
1473
   * @param int    $type
1474
   * @param string $var
1475
   * @param int    $filter
1476
   * @param mixed  $option
1477
   *
1478
   * @return mixed
1479
   */
1480 View Code Duplication
  public static function filter_input($type, $var, $filter = FILTER_DEFAULT, $option = 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...
1481
  {
1482
    if (4 > func_num_args()) {
1483
      $var = filter_input($type, $var, $filter);
1484
    } else {
1485
      $var = filter_input($type, $var, $filter, $option);
1486
    }
1487
1488
    return self::filter($var);
1489 1
  }
1490
1491 1
  /**
1492 1
   * "filter_input_array()"-wrapper with normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
1493 1
   *
1494 1
   * @param int   $type
1495
   * @param mixed $definition
1496
   * @param bool  $add_empty
1497 1
   *
1498
   * @return mixed
1499
   */
1500 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...
1501
  {
1502
    if (2 > func_num_args()) {
1503
      $a = filter_input_array($type);
1504
    } else {
1505
      $a = filter_input_array($type, $definition, $add_empty);
1506
    }
1507
1508
    return self::filter($a);
1509 1
  }
1510
1511 1
  /**
1512 1
   * "filter_var()"-wrapper with normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
1513 1
   *
1514 1
   * @param mixed $var
1515
   * @param int   $filter
1516
   * @param mixed $option
1517 1
   *
1518
   * @return mixed
1519
   */
1520 View Code Duplication
  public static function filter_var($var, $filter = FILTER_DEFAULT, $option = 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...
1521
  {
1522
    if (3 > func_num_args()) {
1523
      $var = filter_var($var, $filter);
1524
    } else {
1525
      $var = filter_var($var, $filter, $option);
1526
    }
1527
1528 1
    return self::filter($var);
1529
  }
1530 1
1531
  /**
1532
   * "filter_var_array()"-wrapper with normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
1533
   *
1534
   * @param array $data
1535
   * @param mixed $definition
1536
   * @param bool  $add_empty
1537
   *
1538
   * @return mixed
1539
   */
1540 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...
1541
  {
1542
    if (2 > func_num_args()) {
1543
      $a = filter_var_array($data);
1544
    } else {
1545
      $a = filter_var_array($data, $definition, $add_empty);
1546 7
    }
1547
1548 7
    return self::filter($a);
1549 7
  }
1550
1551 7
  /**
1552
   * Check if the number of unicode characters are not more than the specified integer.
1553 7
   *
1554 2
   * @param string $str      The original string to be checked.
1555
   * @param int    $box_size The size in number of chars to be checked against string.
1556
   *
1557 7
   * @return bool true if string is less than or equal to $box_size, false otherwise.
1558 1
   */
1559 1
  public static function fits_inside($str, $box_size)
1560 1
  {
1561
    return (self::strlen($str) <= $box_size);
1562 7
  }
1563
1564
  /**
1565
   * Try to fix simple broken UTF-8 strings.
1566
   *
1567
   * INFO: Take a look at "UTF8::fix_utf8()" if you need a more advanced fix for broken UTF-8 strings.
1568
   *
1569
   * If you received an UTF-8 string that was converted from Windows-1252 as it was ISO-8859-1
1570
   * (ignoring Windows-1252 chars from 80 to 9F) use this function to fix it.
1571
   * See: http://en.wikipedia.org/wiki/Windows-1252
1572 1
   *
1573
   * @param string $str <p>The input string</p>
1574 1
   *
1575
   * @return string
1576 1
   */
1577
  public static function fix_simple_utf8($str)
1578
  {
1579 1
    static $brokenUtf8ToUtf8Keys = null;
1580 1
    static $brokenUtf8ToUtf8Values = null;
1581
1582 1
    $str = (string)$str;
1583
1584
    if (!isset($str[0])) {
1585 1
      return '';
1586 1
    }
1587 1
1588 1
    if ($brokenUtf8ToUtf8Keys === null) {
1589 1
      $brokenUtf8ToUtf8Keys = array_keys(self::$brokenUtf8ToUtf8);
1590
      $brokenUtf8ToUtf8Values = array_values(self::$brokenUtf8ToUtf8);
1591 1
    }
1592
1593
    return str_replace($brokenUtf8ToUtf8Keys, $brokenUtf8ToUtf8Values, $str);
1594
  }
1595
1596
  /**
1597
   * Fix a double (or multiple) encoded UTF8 string.
1598
   *
1599
   * @param string|string[] $str <p>You can use a string or an array of strings.</p>
1600
   *
1601 1
   * @return mixed
1602
   */
1603 1
  public static function fix_utf8($str)
1604
  {
1605
    if (is_array($str)) {
1606
1607 1
      foreach ($str as $k => $v) {
1608
        /** @noinspection AlterInForeachInspection */
1609
        /** @noinspection OffsetOperationsInspection */
1610
        $str[$k] = self::fix_utf8($v);
1611
      }
1612
1613
      return $str;
1614
    }
1615
1616
    $last = '';
1617
    while ($last !== $str) {
1618
      $last = $str;
1619
      $str = self::to_utf8(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 1619 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...
1620
    }
1621
1622
    return $str;
1623 1
  }
1624
1625 1
  /**
1626 1
   * Get character of a specific character.
1627
   *
1628
   * @param string $char
1629 1
   *
1630
   * @return string <p>'RTL' or 'LTR'</p>
1631 1
   */
1632 1
  public static function getCharDirection($char)
1633 1
  {
1634 1
    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
1635 1
      self::checkForSupport();
1636 1
    }
1637 1
1638 1
    if (self::$support['intlChar'] === true) {
1639 1
      $tmpReturn = \IntlChar::charDirection($char);
1640 1
1641 1
      // from "IntlChar"-Class
1642
      $charDirection = array(
1643
          'RTL' => array(1, 13, 14, 15, 21),
1644
          'LTR' => array(0, 11, 12, 20),
1645
      );
1646
1647
      if (in_array($tmpReturn, $charDirection['LTR'], true)) {
1648
        return 'LTR';
1649
      } elseif (in_array($tmpReturn, $charDirection['RTL'], true)) {
1650
        return 'RTL';
1651
      }
1652
    }
1653
1654
    $c = static::chr_to_decimal($char);
1655
1656
    if (!(0x5be <= $c && 0x10b7f >= $c)) {
1657
      return 'LTR';
1658
    }
1659
1660
    if (0x85e >= $c) {
1661 1
1662 1
      if (0x5be === $c ||
1663
          0x5c0 === $c ||
1664
          0x5c3 === $c ||
1665
          0x5c6 === $c ||
1666
          (0x5d0 <= $c && 0x5ea >= $c) ||
1667
          (0x5f0 <= $c && 0x5f4 >= $c) ||
1668
          0x608 === $c ||
1669
          0x60b === $c ||
1670
          0x60d === $c ||
1671
          0x61b === $c ||
1672
          (0x61e <= $c && 0x64a >= $c) ||
1673
          (0x66d <= $c && 0x66f >= $c) ||
1674
          (0x671 <= $c && 0x6d5 >= $c) ||
1675
          (0x6e5 <= $c && 0x6e6 >= $c) ||
1676
          (0x6ee <= $c && 0x6ef >= $c) ||
1677
          (0x6fa <= $c && 0x70d >= $c) ||
1678
          0x710 === $c ||
1679
          (0x712 <= $c && 0x72f >= $c) ||
1680
          (0x74d <= $c && 0x7a5 >= $c) ||
1681
          0x7b1 === $c ||
1682
          (0x7c0 <= $c && 0x7ea >= $c) ||
1683
          (0x7f4 <= $c && 0x7f5 >= $c) ||
1684
          0x7fa === $c ||
1685
          (0x800 <= $c && 0x815 >= $c) ||
1686
          0x81a === $c ||
1687
          0x824 === $c ||
1688
          0x828 === $c ||
1689
          (0x830 <= $c && 0x83e >= $c) ||
1690
          (0x840 <= $c && 0x858 >= $c) ||
1691
          0x85e === $c
1692
      ) {
1693
        return 'RTL';
1694
      }
1695
1696
    } elseif (0x200f === $c) {
1697
1698
      return 'RTL';
1699
1700
    } elseif (0xfb1d <= $c) {
1701
1702
      if (0xfb1d === $c ||
1703
          (0xfb1f <= $c && 0xfb28 >= $c) ||
1704
          (0xfb2a <= $c && 0xfb36 >= $c) ||
1705
          (0xfb38 <= $c && 0xfb3c >= $c) ||
1706
          0xfb3e === $c ||
1707
          (0xfb40 <= $c && 0xfb41 >= $c) ||
1708
          (0xfb43 <= $c && 0xfb44 >= $c) ||
1709
          (0xfb46 <= $c && 0xfbc1 >= $c) ||
1710
          (0xfbd3 <= $c && 0xfd3d >= $c) ||
1711
          (0xfd50 <= $c && 0xfd8f >= $c) ||
1712
          (0xfd92 <= $c && 0xfdc7 >= $c) ||
1713
          (0xfdf0 <= $c && 0xfdfc >= $c) ||
1714
          (0xfe70 <= $c && 0xfe74 >= $c) ||
1715
          (0xfe76 <= $c && 0xfefc >= $c) ||
1716
          (0x10800 <= $c && 0x10805 >= $c) ||
1717
          0x10808 === $c ||
1718
          (0x1080a <= $c && 0x10835 >= $c) ||
1719
          (0x10837 <= $c && 0x10838 >= $c) ||
1720
          0x1083c === $c ||
1721 1
          (0x1083f <= $c && 0x10855 >= $c) ||
1722
          (0x10857 <= $c && 0x1085f >= $c) ||
1723 1
          (0x10900 <= $c && 0x1091b >= $c) ||
1724 1
          (0x10920 <= $c && 0x10939 >= $c) ||
1725
          0x1093f === $c ||
1726 1
          0x10a00 === $c ||
1727
          (0x10a10 <= $c && 0x10a13 >= $c) ||
1728
          (0x10a15 <= $c && 0x10a17 >= $c) ||
1729
          (0x10a19 <= $c && 0x10a33 >= $c) ||
1730
          (0x10a40 <= $c && 0x10a47 >= $c) ||
1731
          (0x10a50 <= $c && 0x10a58 >= $c) ||
1732
          (0x10a60 <= $c && 0x10a7f >= $c) ||
1733
          (0x10b00 <= $c && 0x10b35 >= $c) ||
1734
          (0x10b40 <= $c && 0x10b55 >= $c) ||
1735
          (0x10b58 <= $c && 0x10b72 >= $c) ||
1736
          (0x10b78 <= $c && 0x10b7f >= $c)
1737
      ) {
1738
        return 'RTL';
1739
      }
1740
    }
1741 2
1742
    return 'LTR';
1743 2
  }
1744 1
1745
  /**
1746
   * get data from "/data/*.ser"
1747 1
   *
1748
   * @param string $file
1749
   *
1750
   * @return bool|string|array|int <p>Will return false on error.</p>
1751
   */
1752
  private static function getData($file)
1753
  {
1754
    $file = __DIR__ . '/data/' . $file . '.php';
1755
    if (file_exists($file)) {
1756
      /** @noinspection PhpIncludeInspection */
1757
      return require $file;
1758
    } else {
1759
      return false;
1760
    }
1761 1
  }
1762
1763 1
  /**
1764
   * alias for "UTF8::string_has_bom()"
1765
   *
1766
   * @see UTF8::string_has_bom()
1767
   *
1768
   * @param string $str
1769
   *
1770
   * @return bool
1771
   */
1772
  public static function hasBom($str)
1773
  {
1774
    return self::string_has_bom($str);
1775
  }
1776
1777 2
  /**
1778
   * Converts hexadecimal U+xxxx code point representation to integer.
1779
   *
1780 2
   * INFO: opposite to UTF8::int_to_hex()
1781
   *
1782 2
   * @param string $str <p>The hexadecimal code point representation.</p>
1783 2
   *
1784 1
   * @return int|false <p>The code point, or false on failure.</p>
1785 1
   */
1786
  public static function hex_to_int($str)
1787 2
  {
1788
    if (!$str) {
1789
      return false;
1790
    }
1791 2
1792 2
    if (preg_match('/^(?:\\\u|U\+|)([a-z0-9]{4,6})$/i', $str, $match)) {
1793 2
      return intval($match[1], 16);
1794
    }
1795 2
1796
    return false;
1797
  }
1798
1799
  /**
1800
   * alias for "UTF8::html_entity_decode()"
1801
   *
1802
   * @see UTF8::html_entity_decode()
1803
   *
1804
   * @param string $str
1805
   * @param int    $flags
1806
   * @param string $encoding
1807
   *
1808
   * @return string
1809
   */
1810
  public static function html_decode($str, $flags = null, $encoding = 'UTF-8')
1811
  {
1812
    return self::html_entity_decode($str, $flags, $encoding);
1813
  }
1814
1815
  /**
1816
   * Converts a UTF-8 string to a series of HTML numbered entities.
1817
   *
1818
   * INFO: opposite to UTF8::html_decode()
1819
   *
1820
   * @param string $str            <p>The Unicode string to be encoded as numbered entities.</p>
1821
   * @param bool   $keepAsciiChars [optional] <p>Keep ASCII chars.</p>
1822
   * @param string $encoding       [optional] <p>Default is UTF-8</p>
1823
   *
1824
   * @return string <p>HTML numbered entities.</p>
1825
   */
1826
  public static function html_encode($str, $keepAsciiChars = false, $encoding = 'UTF-8')
1827
  {
1828
    # INFO: http://stackoverflow.com/questions/35854535/better-explanation-of-convmap-in-mb-encode-numericentity
1829
    if (function_exists('mb_encode_numericentity')) {
1830
1831
      $startCode = 0x00;
1832
      if ($keepAsciiChars === true) {
1833
        $startCode = 0x80;
1834
      }
1835
1836
      if ($encoding !== 'UTF-8') {
1837
        $encoding = self::normalize_encoding($encoding);
1838
      }
1839
1840
      return mb_encode_numericentity(
1841
          $str,
1842
          array($startCode, 0xffff, 0, 0xffff,),
1843
          $encoding
1844
      );
1845
    }
1846
1847
    return implode(
1848
        array_map(
1849
            function ($data) use ($keepAsciiChars) {
1850
              return UTF8::single_chr_html_encode($data, $keepAsciiChars);
1851
            },
1852
            self::split($str)
1853
        )
1854
    );
1855
  }
1856
1857
  /**
1858
   * UTF-8 version of html_entity_decode()
1859
   *
1860
   * The reason we are not using html_entity_decode() by itself is because
1861
   * while it is not technically correct to leave out the semicolon
1862
   * at the end of an entity most browsers will still interpret the entity
1863
   * correctly. html_entity_decode() does not convert entities without
1864
   * semicolons, so we are left with our own little solution here. Bummer.
1865
   *
1866
   * Convert all HTML entities to their applicable characters
1867
   *
1868
   * INFO: opposite to UTF8::html_encode()
1869
   *
1870
   * @link http://php.net/manual/en/function.html-entity-decode.php
1871
   *
1872
   * @param string $str      <p>
1873
   *                         The input string.
1874
   *                         </p>
1875
   * @param int    $flags    [optional] <p>
1876
   *                         A bitmask of one or more of the following flags, which specify how to handle quotes and
1877 18
   *                         which document type to use. The default is ENT_COMPAT | ENT_HTML401.
1878
   *                         <table>
1879 18
   *                         Available <i>flags</i> constants
1880
   *                         <tr valign="top">
1881 18
   *                         <td>Constant Name</td>
1882 6
   *                         <td>Description</td>
1883
   *                         </tr>
1884
   *                         <tr valign="top">
1885 18
   *                         <td><b>ENT_COMPAT</b></td>
1886 7
   *                         <td>Will convert double-quotes and leave single-quotes alone.</td>
1887
   *                         </tr>
1888
   *                         <tr valign="top">
1889 18
   *                         <td><b>ENT_QUOTES</b></td>
1890 1
   *                         <td>Will convert both double and single quotes.</td>
1891 1
   *                         </tr>
1892
   *                         <tr valign="top">
1893 18
   *                         <td><b>ENT_NOQUOTES</b></td>
1894 4
   *                         <td>Will leave both double and single quotes unconverted.</td>
1895 4
   *                         </tr>
1896 4
   *                         <tr valign="top">
1897
   *                         <td><b>ENT_HTML401</b></td>
1898
   *                         <td>
1899 4
   *                         Handle code as HTML 4.01.
1900
   *                         </td>
1901
   *                         </tr>
1902 18
   *                         <tr valign="top">
1903
   *                         <td><b>ENT_XML1</b></td>
1904 18
   *                         <td>
1905 18
   *                         Handle code as XML 1.
1906
   *                         </td>
1907 16
   *                         </tr>
1908
   *                         <tr valign="top">
1909 16
   *                         <td><b>ENT_XHTML</b></td>
1910 15
   *                         <td>
1911
   *                         Handle code as XHTML.
1912 7
   *                         </td>
1913
   *                         </tr>
1914 18
   *                         <tr valign="top">
1915
   *                         <td><b>ENT_HTML5</b></td>
1916 18
   *                         <td>
1917
   *                         Handle code as HTML 5.
1918
   *                         </td>
1919 18
   *                         </tr>
1920 18
   *                         </table>
1921 18
   *                         </p>
1922
   * @param string $encoding [optional] <p>Encoding to use.</p>
1923 18
   *
1924
   * @return string <p>The decoded string.</p>
1925 18
   */
1926
  public static function html_entity_decode($str, $flags = null, $encoding = 'UTF-8')
1927 18
  {
1928
    $str = (string)$str;
1929
1930
    if (!isset($str[0])) {
1931
      return '';
1932
    }
1933
1934
    if (!isset($str[3])) { // examples: &; || &x;
0 ignored issues
show
Unused Code Comprehensibility introduced by
46% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
1935
      return $str;
1936
    }
1937
1938
    if (
1939
        strpos($str, '&') === false
1940
        ||
1941
        (
1942
            strpos($str, '&#') === false
1943
            &&
1944
            strpos($str, ';') === false
1945
        )
1946
    ) {
1947
      return $str;
1948
    }
1949
1950
    if ($encoding !== 'UTF-8') {
1951
      $encoding = self::normalize_encoding($encoding);
1952
    }
1953
1954
    if ($flags === null) {
1955
      if (Bootup::is_php('5.4') === true) {
1956
        $flags = ENT_COMPAT | ENT_HTML5;
1957
      } else {
1958
        $flags = ENT_COMPAT;
1959
      }
1960
    }
1961
1962
    do {
1963
      $str_compare = $str;
1964
1965
      $str = preg_replace_callback(
1966
          "/&#\d{2,5};/",
1967
          function ($matches) use ($encoding) {
1968
            $returnTmp = \mb_convert_encoding($matches[0], $encoding, 'HTML-ENTITIES');
1969
1970
            if ($returnTmp !== '"' && $returnTmp !== "'") {
1971
              return $returnTmp;
1972
            } else {
1973
              return $matches[0];
1974
            }
1975
          },
1976
          $str
1977
      );
1978
1979
      // decode numeric & UTF16 two byte entities
1980
      $str = html_entity_decode(
1981
          preg_replace('/(&#(?:x0*[0-9a-f]{2,5}(?![0-9a-f;])|(?:0*\d{2,4}(?![0-9;]))))/iS', '$1;', $str),
1982
          $flags,
1983
          $encoding
1984
      );
1985
1986
    } while ($str_compare !== $str);
1987
1988
    return $str;
1989
  }
1990
1991
  /**
1992
   * Convert all applicable characters to HTML entities: UTF-8 version of htmlentities()
1993
   *
1994
   * @link http://php.net/manual/en/function.htmlentities.php
1995
   *
1996
   * @param string $str           <p>
1997
   *                              The input string.
1998
   *                              </p>
1999
   * @param int    $flags         [optional] <p>
2000
   *                              A bitmask of one or more of the following flags, which specify how to handle quotes,
2001
   *                              invalid code unit sequences and the used document type. The default is
2002
   *                              ENT_COMPAT | ENT_HTML401.
2003
   *                              <table>
2004
   *                              Available <i>flags</i> constants
2005
   *                              <tr valign="top">
2006
   *                              <td>Constant Name</td>
2007
   *                              <td>Description</td>
2008
   *                              </tr>
2009
   *                              <tr valign="top">
2010
   *                              <td><b>ENT_COMPAT</b></td>
2011
   *                              <td>Will convert double-quotes and leave single-quotes alone.</td>
2012
   *                              </tr>
2013
   *                              <tr valign="top">
2014
   *                              <td><b>ENT_QUOTES</b></td>
2015
   *                              <td>Will convert both double and single quotes.</td>
2016
   *                              </tr>
2017
   *                              <tr valign="top">
2018
   *                              <td><b>ENT_NOQUOTES</b></td>
2019
   *                              <td>Will leave both double and single quotes unconverted.</td>
2020
   *                              </tr>
2021
   *                              <tr valign="top">
2022
   *                              <td><b>ENT_IGNORE</b></td>
2023
   *                              <td>
2024
   *                              Silently discard invalid code unit sequences instead of returning
2025
   *                              an empty string. Using this flag is discouraged as it
2026
   *                              may have security implications.
2027
   *                              </td>
2028
   *                              </tr>
2029
   *                              <tr valign="top">
2030
   *                              <td><b>ENT_SUBSTITUTE</b></td>
2031
   *                              <td>
2032
   *                              Replace invalid code unit sequences with a Unicode Replacement Character
2033 2
   *                              U+FFFD (UTF-8) or &#38;#38;#FFFD; (otherwise) instead of returning an empty string.
2034
   *                              </td>
2035 2
   *                              </tr>
2036 1
   *                              <tr valign="top">
2037 1
   *                              <td><b>ENT_DISALLOWED</b></td>
2038
   *                              <td>
2039 2
   *                              Replace invalid code points for the given document type with a
2040
   *                              Unicode Replacement Character U+FFFD (UTF-8) or &#38;#38;#FFFD;
2041 2
   *                              (otherwise) instead of leaving them as is. This may be useful, for
2042 1
   *                              instance, to ensure the well-formedness of XML documents with
2043
   *                              embedded external content.
2044
   *                              </td>
2045 2
   *                              </tr>
2046 2
   *                              <tr valign="top">
2047 2
   *                              <td><b>ENT_HTML401</b></td>
2048 2
   *                              <td>
2049 2
   *                              Handle code as HTML 4.01.
2050 1
   *                              </td>
2051
   *                              </tr>
2052 1
   *                              <tr valign="top">
2053 1
   *                              <td><b>ENT_XML1</b></td>
2054 1
   *                              <td>
2055 1
   *                              Handle code as XML 1.
2056 1
   *                              </td>
2057 2
   *                              </tr>
2058
   *                              <tr valign="top">
2059 2
   *                              <td><b>ENT_XHTML</b></td>
2060
   *                              <td>
2061
   *                              Handle code as XHTML.
2062
   *                              </td>
2063
   *                              </tr>
2064
   *                              <tr valign="top">
2065
   *                              <td><b>ENT_HTML5</b></td>
2066
   *                              <td>
2067
   *                              Handle code as HTML 5.
2068
   *                              </td>
2069
   *                              </tr>
2070
   *                              </table>
2071
   *                              </p>
2072
   * @param string $encoding      [optional] <p>
2073
   *                              Like <b>htmlspecialchars</b>,
2074
   *                              <b>htmlentities</b> takes an optional third argument
2075
   *                              <i>encoding</i> which defines encoding used in
2076
   *                              conversion.
2077
   *                              Although this argument is technically optional, you are highly
2078
   *                              encouraged to specify the correct value for your code.
2079
   *                              </p>
2080
   * @param bool   $double_encode [optional] <p>
2081
   *                              When <i>double_encode</i> is turned off PHP will not
2082
   *                              encode existing html entities. The default is to convert everything.
2083
   *                              </p>
2084
   *
2085
   *
2086
   * @return string the encoded string.
2087
   * </p>
2088
   * <p>
2089
   * If the input <i>string</i> contains an invalid code unit
2090
   * sequence within the given <i>encoding</i> an empty string
2091
   * will be returned, unless either the <b>ENT_IGNORE</b> or
2092
   * <b>ENT_SUBSTITUTE</b> flags are set.
2093
   */
2094
  public static function htmlentities($str, $flags = ENT_COMPAT, $encoding = 'UTF-8', $double_encode = true)
2095
  {
2096
    if ($encoding !== 'UTF-8') {
2097
      $encoding = self::normalize_encoding($encoding);
2098
    }
2099
2100
    $str = htmlentities($str, $flags, $encoding, $double_encode);
2101
2102
    if ($encoding !== 'UTF-8') {
2103
      return $str;
2104
    }
2105
2106
    $byteLengths = self::chr_size_list($str);
2107
    $search = array();
2108
    $replacements = array();
2109
    foreach ($byteLengths as $counter => $byteLength) {
2110
      if ($byteLength >= 3) {
2111
        $char = self::access($str, $counter);
2112
2113
        if (!isset($replacements[$char])) {
2114
          $search[$char] = $char;
2115
          $replacements[$char] = self::html_encode($char);
0 ignored issues
show
Security Bug introduced by
It seems like $char defined by self::access($str, $counter) on line 2111 can also be of type false; however, voku\helper\UTF8::html_encode() does only seem to accept string, did you maybe forget to handle an error condition?

This check looks for type mismatches where the missing type is false. This is usually indicative of an error condtion.

Consider the follow example

<?php

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

    return false;
}

This function either returns a new DateTime object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned false before passing on the value to another function or method that may not be able to handle a false.

Loading history...
2116
        }
2117
      }
2118
    }
2119
2120
    return str_replace($search, $replacements, $str);
2121
  }
2122
2123
  /**
2124
   * Convert only special characters to HTML entities: UTF-8 version of htmlspecialchars()
2125
   *
2126
   * INFO: Take a look at "UTF8::htmlentities()"
2127
   *
2128
   * @link http://php.net/manual/en/function.htmlspecialchars.php
2129
   *
2130
   * @param string $str           <p>
2131
   *                              The string being converted.
2132
   *                              </p>
2133
   * @param int    $flags         [optional] <p>
2134
   *                              A bitmask of one or more of the following flags, which specify how to handle quotes,
2135
   *                              invalid code unit sequences and the used document type. The default is
2136
   *                              ENT_COMPAT | ENT_HTML401.
2137
   *                              <table>
2138
   *                              Available <i>flags</i> constants
2139
   *                              <tr valign="top">
2140
   *                              <td>Constant Name</td>
2141
   *                              <td>Description</td>
2142
   *                              </tr>
2143
   *                              <tr valign="top">
2144
   *                              <td><b>ENT_COMPAT</b></td>
2145
   *                              <td>Will convert double-quotes and leave single-quotes alone.</td>
2146
   *                              </tr>
2147
   *                              <tr valign="top">
2148
   *                              <td><b>ENT_QUOTES</b></td>
2149
   *                              <td>Will convert both double and single quotes.</td>
2150
   *                              </tr>
2151
   *                              <tr valign="top">
2152
   *                              <td><b>ENT_NOQUOTES</b></td>
2153
   *                              <td>Will leave both double and single quotes unconverted.</td>
2154
   *                              </tr>
2155
   *                              <tr valign="top">
2156
   *                              <td><b>ENT_IGNORE</b></td>
2157
   *                              <td>
2158
   *                              Silently discard invalid code unit sequences instead of returning
2159
   *                              an empty string. Using this flag is discouraged as it
2160
   *                              may have security implications.
2161
   *                              </td>
2162
   *                              </tr>
2163
   *                              <tr valign="top">
2164
   *                              <td><b>ENT_SUBSTITUTE</b></td>
2165
   *                              <td>
2166
   *                              Replace invalid code unit sequences with a Unicode Replacement Character
2167
   *                              U+FFFD (UTF-8) or &#38;#38;#FFFD; (otherwise) instead of returning an empty string.
2168
   *                              </td>
2169
   *                              </tr>
2170
   *                              <tr valign="top">
2171 1
   *                              <td><b>ENT_DISALLOWED</b></td>
2172
   *                              <td>
2173 1
   *                              Replace invalid code points for the given document type with a
2174
   *                              Unicode Replacement Character U+FFFD (UTF-8) or &#38;#38;#FFFD;
2175
   *                              (otherwise) instead of leaving them as is. This may be useful, for
2176
   *                              instance, to ensure the well-formedness of XML documents with
2177 1
   *                              embedded external content.
2178
   *                              </td>
2179
   *                              </tr>
2180
   *                              <tr valign="top">
2181
   *                              <td><b>ENT_HTML401</b></td>
2182
   *                              <td>
2183
   *                              Handle code as HTML 4.01.
2184
   *                              </td>
2185 1
   *                              </tr>
2186
   *                              <tr valign="top">
2187 1
   *                              <td><b>ENT_XML1</b></td>
2188
   *                              <td>
2189
   *                              Handle code as XML 1.
2190
   *                              </td>
2191
   *                              </tr>
2192
   *                              <tr valign="top">
2193
   *                              <td><b>ENT_XHTML</b></td>
2194
   *                              <td>
2195
   *                              Handle code as XHTML.
2196
   *                              </td>
2197
   *                              </tr>
2198
   *                              <tr valign="top">
2199
   *                              <td><b>ENT_HTML5</b></td>
2200 3
   *                              <td>
2201
   *                              Handle code as HTML 5.
2202 3
   *                              </td>
2203 3
   *                              </tr>
2204
   *                              </table>
2205 3
   *                              </p>
2206
   * @param string $encoding      [optional] <p>
2207 3
   *                              Defines encoding used in conversion.
2208
   *                              </p>
2209
   *                              <p>
2210
   *                              For the purposes of this function, the encodings
2211
   *                              ISO-8859-1, ISO-8859-15,
2212
   *                              UTF-8, cp866,
2213
   *                              cp1251, cp1252, and
2214
   *                              KOI8-R are effectively equivalent, provided the
2215
   *                              <i>string</i> itself is valid for the encoding, as
2216
   *                              the characters affected by <b>htmlspecialchars</b> occupy
2217
   *                              the same positions in all of these encodings.
2218 1
   *                              </p>
2219
   * @param bool   $double_encode [optional] <p>
2220 1
   *                              When <i>double_encode</i> is turned off PHP will not
2221
   *                              encode existing html entities, the default is to convert everything.
2222
   *                              </p>
2223
   *
2224
   * @return string The converted string.
2225
   * </p>
2226
   * <p>
2227
   * If the input <i>string</i> contains an invalid code unit
2228 3
   * sequence within the given <i>encoding</i> an empty string
2229
   * will be returned, unless either the <b>ENT_IGNORE</b> or
2230 3
   * <b>ENT_SUBSTITUTE</b> flags are set.
2231
   */
2232
  public static function htmlspecialchars($str, $flags = ENT_COMPAT, $encoding = 'UTF-8', $double_encode = true)
2233
  {
2234
    if ($encoding !== 'UTF-8') {
2235
      $encoding = self::normalize_encoding($encoding);
2236
    }
2237
2238
    return htmlspecialchars($str, $flags, $encoding, $double_encode);
2239
  }
2240
2241
  /**
2242 2
   * Checks whether iconv is available on the server.
2243
   *
2244 2
   * @return bool <p><strong>true</strong> if available, <strong>false</strong> otherwise.</p>
2245
   */
2246
  public static function iconv_loaded()
2247
  {
2248
    return extension_loaded('iconv') ? true : false;
2249
  }
2250
2251
  /**
2252
   * Converts Integer to hexadecimal U+xxxx code point representation.
2253
   *
2254
   * INFO: opposite to UTF8::hex_to_int()
2255
   *
2256 1
   * @param int    $int  <p>The integer to be converted to hexadecimal code point.</p>
2257
   * @param string $pfix [optional]
2258 1
   *
2259
   * @return string <p>The code point, or empty string on failure.</p>
2260
   */
2261
  public static function int_to_hex($int, $pfix = 'U+')
2262
  {
2263
    if (ctype_digit((string)$int)) {
2264
      $hex = dechex((int)$int);
2265
2266
      $hex = (strlen($hex) < 4 ? substr('0000' . $hex, -4) : $hex);
2267
2268
      return $pfix . $hex;
2269
    }
2270
2271
    return '';
2272
  }
2273
2274
  /**
2275
   * Checks whether intl-char is available on the server.
2276
   *
2277
   * @return bool <p><strong>true</strong> if available, <strong>false</strong> otherwise.</p>
2278
   */
2279
  public static function intlChar_loaded()
2280
  {
2281
    return (Bootup::is_php('7.0') === true && class_exists('IntlChar') === true);
2282
  }
2283
2284
  /**
2285
   * Checks whether intl is available on the server.
2286
   *
2287
   * @return bool <p><strong>true</strong> if available, <strong>false</strong> otherwise.</p>
2288
   */
2289
  public static function intl_loaded()
2290
  {
2291
    return extension_loaded('intl') ? true : false;
2292
  }
2293
2294
  /**
2295
   * alias for "UTF8::is_ascii()"
2296
   *
2297
   * @see UTF8::is_ascii()
2298 1
   *
2299
   * @param string $str
2300 1
   *
2301
   * @return boolean
2302
   */
2303
  public static function isAscii($str)
2304
  {
2305
    return self::is_ascii($str);
2306
  }
2307
2308
  /**
2309
   * alias for "UTF8::is_base64()"
2310
   *
2311
   * @see UTF8::is_base64()
2312
   *
2313
   * @param string $str
2314
   *
2315
   * @return bool
2316
   */
2317
  public static function isBase64($str)
2318
  {
2319
    return self::is_base64($str);
2320
  }
2321
2322
  /**
2323
   * alias for "UTF8::is_binary()"
2324
   *
2325
   * @see UTF8::is_binary()
2326 1
   *
2327
   * @param string $str
2328 1
   *
2329
   * @return bool
2330
   */
2331
  public static function isBinary($str)
2332
  {
2333
    return self::is_binary($str);
2334
  }
2335
2336
  /**
2337
   * alias for "UTF8::is_bom()"
2338
   *
2339
   * @see UTF8::is_bom()
2340 1
   *
2341
   * @param string $utf8_chr
2342 1
   *
2343
   * @return boolean
2344
   */
2345
  public static function isBom($utf8_chr)
2346
  {
2347
    return self::is_bom($utf8_chr);
2348
  }
2349
2350
  /**
2351
   * alias for "UTF8::is_html()"
2352
   *
2353
   * @see UTF8::is_html()
2354
   *
2355 16
   * @param string $str
2356
   *
2357 16
   * @return boolean
2358
   */
2359
  public static function isHtml($str)
2360
  {
2361
    return self::is_html($str);
2362
  }
2363
2364
  /**
2365
   * alias for "UTF8::is_json()"
2366
   *
2367
   * @see UTF8::is_json()
2368
   *
2369
   * @param string $str
2370 14
   *
2371
   * @return bool
2372 14
   */
2373
  public static function isJson($str)
2374
  {
2375
    return self::is_json($str);
2376
  }
2377
2378
  /**
2379
   * alias for "UTF8::is_utf16()"
2380
   *
2381
   * @see UTF8::is_utf16()
2382 1
   *
2383
   * @param string $str
2384 1
   *
2385
   * @return int|false false if is't not UTF16, 1 for UTF-16LE, 2 for UTF-16BE.
2386 1
   */
2387 1
  public static function isUtf16($str)
2388
  {
2389
    return self::is_utf16($str);
2390 1
  }
2391 1
2392
  /**
2393 1
   * alias for "UTF8::is_utf32()"
2394
   *
2395
   * @see UTF8::is_utf32()
2396
   *
2397
   * @param string $str
2398
   *
2399
   * @return int|false false if is't not UTF16, 1 for UTF-32LE, 2 for UTF-32BE.
2400
   */
2401
  public static function isUtf32($str)
2402
  {
2403
    return self::is_utf32($str);
2404 16
  }
2405
2406
  /**
2407 16
   * alias for "UTF8::is_utf8()"
2408
   *
2409
   * @see UTF8::is_utf8()
2410 16
   *
2411
   * @param string $str
2412 16
   * @param bool   $strict
2413 16
   *
2414 15
   * @return bool
2415 16
   */
2416 6
  public static function isUtf8($str, $strict = false)
2417
  {
2418 15
    return self::is_utf8($str, $strict);
2419
  }
2420
2421
  /**
2422
   * Checks if a string is 7 bit ASCII.
2423
   *
2424
   * @param string $str <p>The string to check.</p>
2425
   *
2426
   * @return bool <p>
2427
   *              <strong>true</strong> if it is ASCII<br />
2428
   *              <strong>false</strong> otherwise
2429
   *              </p>
2430
   */
2431
  public static function is_ascii($str)
2432
  {
2433
    $str = (string)$str;
2434
2435
    if (!isset($str[0])) {
2436
      return true;
2437
    }
2438
2439
    return (bool)!preg_match('/[\x80-\xFF]/', $str);
2440
  }
2441
2442
  /**
2443
   * Returns true if the string is base64 encoded, false otherwise.
2444
   *
2445
   * @param string $str <p>The input string.</p>
2446
   *
2447
   * @return bool <p>Whether or not $str is base64 encoded.</p>
2448
   */
2449
  public static function is_base64($str)
2450
  {
2451
    $str = (string)$str;
2452
2453
    if (!isset($str[0])) {
2454
      return false;
2455
    }
2456
2457
    if (base64_encode(base64_decode($str, true)) === $str) {
2458
      return true;
2459
    } else {
2460
      return false;
2461
    }
2462
  }
2463
2464
  /**
2465
   * Check if the input is binary... (is look like a hack).
2466
   *
2467
   * @param mixed $input
2468
   *
2469 1
   * @return bool
2470
   */
2471 1
  public static function is_binary($input)
2472
  {
2473 1
2474
    $testLength = strlen($input);
2475
2476
    if (
2477
        preg_match('~^[01]+$~', $input)
2478 1
        ||
2479
        substr_count($input, "\x00") > 0
2480 1
        ||
2481
        ($testLength ? substr_count($input, '^ -~') / $testLength > 0.3 : 1 === 0)
2482 1
    ) {
2483 1
      return true;
2484
    } else {
2485 1
      return false;
2486
    }
2487
  }
2488
2489
  /**
2490
   * Check if the file is binary.
2491
   *
2492
   * @param string $file
2493
   *
2494
   * @return boolean
2495
   */
2496 1
  public static function is_binary_file($file)
2497
  {
2498 1
    try {
2499
      $fp = fopen($file, 'r');
2500 1
      $block = fread($fp, 512);
2501
      fclose($fp);
2502
    } catch (\Exception $e) {
2503
      $block = '';
2504
    }
2505 1
2506 1
    return self::is_binary($block);
2507 1
  }
2508 1
2509 1
  /**
2510
   * Checks if the given string is equal to any "Byte Order Mark".
2511 1
   *
2512
   * WARNING: Use "UTF8::string_has_bom()" if you will check BOM in a string.
2513
   *
2514
   * @param string $str <p>The input string.</p>
2515
   *
2516
   * @return bool <p><strong>true</strong> if the $utf8_chr is Byte Order Mark, <strong>false</strong> otherwise.</p>
2517
   */
2518
  public static function is_bom($str)
2519
  {
2520
    foreach (self::$bom as $bomString => $bomByteLength) {
2521
      if ($str === $bomString) {
2522
        return true;
2523
      }
2524
    }
2525
2526 4
    return false;
2527
  }
2528 4
2529
  /**
2530 4
   * Check if the string contains any html-tags <lall>.
2531
   *
2532 4
   * @param string $str <p>The input string.</p>
2533 4
   *
2534 4
   * @return boolean
2535 4
   */
2536 4
  public static function is_html($str)
2537 4
  {
2538 4
    $str = (string)$str;
2539 4
2540 4
    if (!isset($str[0])) {
2541 2
      return false;
2542 2
    }
2543 4
2544 4
    // init
2545 4
    $matches = array();
2546
2547 4
    preg_match("/<\/?\w+((\s+\w+(\s*=\s*(?:\".*?\"|'.*?'|[^'\">\s]+))?)+\s*|\s*)\/?>/", $str, $matches);
2548 4
2549 4
    if (count($matches) == 0) {
2550 4
      return false;
2551 4
    } else {
2552 4
      return true;
2553 4
    }
2554 4
  }
2555 4
2556 3
  /**
2557 3
   * Try to check if "$str" is an json-string.
2558 4
   *
2559 4
   * @param string $str <p>The input string.</p>
2560 4
   *
2561
   * @return bool
2562 4
   */
2563 3
  public static function is_json($str)
2564 2
  {
2565
    $str = (string)$str;
2566 3
2567
    if (!isset($str[0])) {
2568
      return false;
2569
    }
2570 3
2571
    if (
2572 3
        is_object(self::json_decode($str))
2573
        &&
2574
        json_last_error() === JSON_ERROR_NONE
2575
    ) {
2576
      return true;
2577
    } else {
2578
      return false;
2579
    }
2580
  }
2581
2582
  /**
2583
   * Check if the string is UTF-16.
2584
   *
2585
   * @param string $str <p>The input string.</p>
2586 3
   *
2587
   * @return int|false <p>
2588 3
   *                   <strong>false</strong> if is't not UTF-16,<br />
2589
   *                   <strong>1</strong> for UTF-16LE,<br />
2590 3
   *                   <strong>2</strong> for UTF-16BE.
2591
   *                   </p>
2592 3
   */
2593 3 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...
2594 3
  {
2595 3
    $str = self::remove_bom($str);
2596 3
2597 3
    if (self::is_binary($str)) {
2598 3
2599 3
      $maybeUTF16LE = 0;
2600 3
      $test = \mb_convert_encoding($str, 'UTF-8', 'UTF-16LE');
2601 1
      if ($test) {
2602 1
        $test2 = \mb_convert_encoding($test, 'UTF-16LE', 'UTF-8');
2603 3
        $test3 = \mb_convert_encoding($test2, 'UTF-8', 'UTF-16LE');
2604 3
        if ($test3 === $test) {
2605 3
          $strChars = self::count_chars($str, true);
2606
          foreach (self::count_chars($test3, true) as $test3char => $test3charEmpty) {
2607 3
            if (in_array($test3char, $strChars, true) === true) {
2608 3
              $maybeUTF16LE++;
2609 3
            }
2610 3
          }
2611 3
        }
2612 3
      }
2613 3
2614 3
      $maybeUTF16BE = 0;
2615 3
      $test = \mb_convert_encoding($str, 'UTF-8', 'UTF-16BE');
2616 1
      if ($test) {
2617 1
        $test2 = \mb_convert_encoding($test, 'UTF-16BE', 'UTF-8');
2618 3
        $test3 = \mb_convert_encoding($test2, 'UTF-8', 'UTF-16BE');
2619 3
        if ($test3 === $test) {
2620 3
          $strChars = self::count_chars($str, true);
2621
          foreach (self::count_chars($test3, true) as $test3char => $test3charEmpty) {
2622 3
            if (in_array($test3char, $strChars, true) === true) {
2623 1
              $maybeUTF16BE++;
2624 1
            }
2625
          }
2626 1
        }
2627
      }
2628
2629
      if ($maybeUTF16BE !== $maybeUTF16LE) {
2630 3
        if ($maybeUTF16LE > $maybeUTF16BE) {
2631
          return 1;
2632 3
        } else {
2633
          return 2;
2634
        }
2635
      }
2636
2637
    }
2638
2639
    return false;
2640
  }
2641
2642
  /**
2643
   * Check if the string is UTF-32.
2644
   *
2645 43
   * @param string $str
2646
   *
2647 43
   * @return int|false <p>
2648
   *                   <strong>false</strong> if is't not UTF-16,<br />
2649 43
   *                   <strong>1</strong> for UTF-32LE,<br />
2650 3
   *                   <strong>2</strong> for UTF-32BE.
2651
   *                   </p>
2652
   */
2653 41 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...
2654 1
  {
2655 1
    $str = self::remove_bom($str);
2656
2657
    if (self::is_binary($str)) {
2658
2659
      $maybeUTF32LE = 0;
2660
      $test = \mb_convert_encoding($str, 'UTF-8', 'UTF-32LE');
2661
      if ($test) {
2662
        $test2 = \mb_convert_encoding($test, 'UTF-32LE', 'UTF-8');
2663 41
        $test3 = \mb_convert_encoding($test2, 'UTF-8', 'UTF-32LE');
2664
        if ($test3 === $test) {
2665
          $strChars = self::count_chars($str, true);
2666
          foreach (self::count_chars($test3, true) as $test3char => $test3charEmpty) {
2667
            if (in_array($test3char, $strChars, true) === true) {
2668
              $maybeUTF32LE++;
2669
            }
2670
          }
2671
        }
2672
      }
2673 41
2674
      $maybeUTF32BE = 0;
2675 41
      $test = \mb_convert_encoding($str, 'UTF-8', 'UTF-32BE');
2676 41
      if ($test) {
2677 41
        $test2 = \mb_convert_encoding($test, 'UTF-32BE', 'UTF-8');
2678
        $test3 = \mb_convert_encoding($test2, 'UTF-8', 'UTF-32BE');
2679
        if ($test3 === $test) {
2680 41
          $strChars = self::count_chars($str, true);
2681 41
          foreach (self::count_chars($test3, true) as $test3char => $test3charEmpty) {
2682 41
            if (in_array($test3char, $strChars, true) === true) {
2683
              $maybeUTF32BE++;
2684
            }
2685 41
          }
2686
        }
2687 36
      }
2688 41
2689
      if ($maybeUTF32BE !== $maybeUTF32LE) {
2690 34
        if ($maybeUTF32LE > $maybeUTF32BE) {
2691 34
          return 1;
2692 34
        } else {
2693 34
          return 2;
2694 39
        }
2695
      }
2696 21
2697 21
    }
2698 21
2699 21
    return false;
2700 33
  }
2701
2702 9
  /**
2703 9
   * Checks whether the passed string contains only byte sequences that appear valid UTF-8 characters.
2704 9
   *
2705 9
   * @see    http://hsivonen.iki.fi/php-utf8/
2706 16
   *
2707
   * @param string $str    <p>The string to be checked.</p>
2708
   * @param bool   $strict <p>Check also if the string is not UTF-16 or UTF-32.</p>
2709
   *
2710
   * @return bool
2711
   */
2712
  public static function is_utf8($str, $strict = false)
2713
  {
2714
    $str = (string)$str;
2715 3
2716 3
    if (!isset($str[0])) {
2717 3
      return true;
2718 3
    }
2719 9
2720
    if ($strict === true) {
2721 3
      if (self::is_utf16($str) !== false) {
2722 3
        return false;
2723 3
      }
2724 3
2725 3
      if (self::is_utf32($str) !== false) {
2726
        return false;
2727
      }
2728
    }
2729 5
2730
    if (self::pcre_utf8_support() !== true) {
2731 41
2732
      // If even just the first character can be matched, when the /u
2733
      // modifier is used, then it's valid UTF-8. If the UTF-8 is somehow
2734 36
      // invalid, nothing at all will match, even if the string contains
2735
      // some valid sequences
2736 33
      return (preg_match('/^.{1}/us', $str, $ar) === 1);
2737 33
2738 33
    } else {
2739 33
2740
      $mState = 0; // cached expected number of octets after the current octet
2741
      // until the beginning of the next UTF8 character sequence
2742
      $mUcs4 = 0; // cached Unicode character
2743
      $mBytes = 1; // cached expected number of octets in the current sequence
2744 33
      $len = strlen($str);
2745
2746
      /** @noinspection ForeachInvariantsInspection */
2747
      for ($i = 0; $i < $len; $i++) {
2748
        $in = ord($str[$i]);
2749
        if ($mState === 0) {
2750 33
          // When mState is zero we expect either a US-ASCII character or a
2751 33
          // multi-octet sequence.
2752 33
          if (0 === (0x80 & $in)) {
2753 33
            // US-ASCII, pass straight through.
2754
            $mBytes = 1;
2755 33 View Code Duplication
          } elseif (0xC0 === (0xE0 & $in)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
2756
            // First octet of 2 octet sequence.
2757 33
            $mUcs4 = $in;
2758 33
            $mUcs4 = ($mUcs4 & 0x1F) << 6;
2759 5
            $mState = 1;
2760
            $mBytes = 2;
2761
          } elseif (0xE0 === (0xF0 & $in)) {
2762 33
            // First octet of 3 octet sequence.
2763 33
            $mUcs4 = $in;
2764 33
            $mUcs4 = ($mUcs4 & 0x0F) << 12;
2765 33
            $mState = 2;
2766 33
            $mBytes = 3;
2767 View Code Duplication
          } elseif (0xF0 === (0xF8 & $in)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
2768
            // First octet of 4 octet sequence.
2769
            $mUcs4 = $in;
2770
            $mUcs4 = ($mUcs4 & 0x07) << 18;
2771 18
            $mState = 3;
2772
            $mBytes = 4;
2773
          } elseif (0xF8 === (0xFC & $in)) {
2774 41
            /* First octet of 5 octet sequence.
2775
            *
2776 20
            * This is illegal because the encoded codepoint must be either
2777
            * (a) not the shortest form or
2778
            * (b) outside the Unicode range of 0-0x10FFFF.
2779
            * Rather than trying to resynchronize, we will carry on until the end
2780
            * of the sequence and let the later error handling code catch it.
2781
            */
2782
            $mUcs4 = $in;
2783
            $mUcs4 = ($mUcs4 & 0x03) << 24;
2784
            $mState = 4;
2785
            $mBytes = 5;
2786 View Code Duplication
          } elseif (0xFC === (0xFE & $in)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
2787
            // First octet of 6 octet sequence, see comments for 5 octet sequence.
2788
            $mUcs4 = $in;
2789
            $mUcs4 = ($mUcs4 & 1) << 30;
2790
            $mState = 5;
2791
            $mBytes = 6;
2792
          } else {
2793
            /* Current octet is neither in the US-ASCII range nor a legal first
2794
             * octet of a multi-octet sequence.
2795
             */
2796
            return false;
2797
          }
2798
        } else {
2799
          // When mState is non-zero, we expect a continuation of the multi-octet
2800
          // sequence
2801
          if (0x80 === (0xC0 & $in)) {
2802
            // Legal continuation.
2803
            $shift = ($mState - 1) * 6;
2804
            $tmp = $in;
2805
            $tmp = ($tmp & 0x0000003F) << $shift;
2806
            $mUcs4 |= $tmp;
2807
            /**
2808
             * End of the multi-octet sequence. mUcs4 now contains the final
2809
             * Unicode code point to be output
2810
             */
2811
            if (0 === --$mState) {
2812
              /*
2813
              * Check for illegal sequences and code points.
2814
              */
2815
              // From Unicode 3.1, non-shortest form is illegal
2816 2
              if (
2817
                  (2 === $mBytes && $mUcs4 < 0x0080) ||
2818 2
                  (3 === $mBytes && $mUcs4 < 0x0800) ||
2819
                  (4 === $mBytes && $mUcs4 < 0x10000) ||
2820 2
                  (4 < $mBytes) ||
2821 2
                  // From Unicode 3.2, surrogate characters are illegal.
2822 2
                  (($mUcs4 & 0xFFFFF800) === 0xD800) ||
2823
                  // Code points outside the Unicode range are illegal.
2824
                  ($mUcs4 > 0x10FFFF)
2825
              ) {
2826 2
                return false;
2827
              }
2828
              // initialize UTF8 cache
2829
              $mState = 0;
2830
              $mUcs4 = 0;
2831
              $mBytes = 1;
2832
            }
2833
          } else {
2834
            /**
2835
             *((0xC0 & (*in) != 0x80) && (mState != 0))
2836
             * Incomplete multi-octet sequence.
2837
             */
2838
            return false;
2839
          }
2840
        }
2841
      }
2842
2843
      return true;
2844
    }
2845
  }
2846
2847
  /**
2848
   * (PHP 5 &gt;= 5.2.0, PECL json &gt;= 1.2.0)<br/>
2849
   * Decodes a JSON string
2850
   *
2851
   * @link http://php.net/manual/en/function.json-decode.php
2852
   *
2853
   * @param string $json    <p>
2854
   *                        The <i>json</i> string being decoded.
2855
   *                        </p>
2856
   *                        <p>
2857
   *                        This function only works with UTF-8 encoded strings.
2858
   *                        </p>
2859
   *                        <p>PHP implements a superset of
2860
   *                        JSON - it will also encode and decode scalar types and <b>NULL</b>. The JSON standard
2861
   *                        only supports these values when they are nested inside an array or an object.
2862
   *                        </p>
2863
   * @param bool   $assoc   [optional] <p>
2864
   *                        When <b>TRUE</b>, returned objects will be converted into
2865 2
   *                        associative arrays.
2866
   *                        </p>
2867 2
   * @param int    $depth   [optional] <p>
2868
   *                        User specified recursion depth.
2869 2
   *                        </p>
2870
   * @param int    $options [optional] <p>
2871
   *                        Bitmask of JSON decode options. Currently only
2872 2
   *                        <b>JSON_BIGINT_AS_STRING</b>
2873
   *                        is supported (default is to cast large integers as floats)
2874
   *                        </p>
2875 2
   *
2876
   * @return mixed the value encoded in <i>json</i> in appropriate
2877
   * PHP type. Values true, false and
2878
   * null (case-insensitive) are returned as <b>TRUE</b>, <b>FALSE</b>
2879
   * and <b>NULL</b> respectively. <b>NULL</b> is returned if the
2880
   * <i>json</i> cannot be decoded or if the encoded
2881
   * data is deeper than the recursion limit.
2882
   */
2883
  public static function json_decode($json, $assoc = false, $depth = 512, $options = 0)
2884
  {
2885 6
    $json = self::filter($json);
2886
2887 6
    if (Bootup::is_php('5.4') === true) {
2888
      $json = json_decode($json, $assoc, $depth, $options);
2889
    } else {
2890
      $json = json_decode($json, $assoc, $depth);
2891
    }
2892
2893
    return $json;
2894
  }
2895
2896
  /**
2897
   * (PHP 5 &gt;= 5.2.0, PECL json &gt;= 1.2.0)<br/>
2898 24
   * Returns the JSON representation of a value.
2899
   *
2900 24
   * @link http://php.net/manual/en/function.json-encode.php
2901
   *
2902 24
   * @param mixed $value   <p>
2903 2
   *                       The <i>value</i> being encoded. Can be any type except
2904
   *                       a resource.
2905
   *                       </p>
2906
   *                       <p>
2907 23
   *                       All string data must be UTF-8 encoded.
2908 2
   *                       </p>
2909
   *                       <p>PHP implements a superset of
2910
   *                       JSON - it will also encode and decode scalar types and <b>NULL</b>. The JSON standard
2911 23
   *                       only supports these values when they are nested inside an array or an object.
2912
   *                       </p>
2913 23
   * @param int   $options [optional] <p>
2914
   *                       Bitmask consisting of <b>JSON_HEX_QUOT</b>,
2915
   *                       <b>JSON_HEX_TAG</b>,
2916
   *                       <b>JSON_HEX_AMP</b>,
2917
   *                       <b>JSON_HEX_APOS</b>,
2918
   *                       <b>JSON_NUMERIC_CHECK</b>,
2919
   *                       <b>JSON_PRETTY_PRINT</b>,
2920
   *                       <b>JSON_UNESCAPED_SLASHES</b>,
2921
   *                       <b>JSON_FORCE_OBJECT</b>,
2922
   *                       <b>JSON_UNESCAPED_UNICODE</b>. The behaviour of these
2923 1
   *                       constants is described on
2924
   *                       the JSON constants page.
2925 1
   *                       </p>
2926
   * @param int   $depth   [optional] <p>
2927
   *                       Set the maximum depth. Must be greater than zero.
2928
   *                       </p>
2929 1
   *
2930
   * @return string a JSON encoded string on success or <b>FALSE</b> on failure.
2931
   */
2932
  public static function json_encode($value, $options = 0, $depth = 512)
2933
  {
2934
    $value = self::filter($value);
2935
2936
    if (Bootup::is_php('5.5')) {
2937
      $json = json_encode($value, $options, $depth);
2938
    } else {
2939
      $json = json_encode($value, $options);
2940 1
    }
2941
2942 1
    return $json;
2943 1
  }
2944 1
2945
  /**
2946 1
   * Makes string's first char lowercase.
2947
   *
2948
   * @param string $str <p>The input string</p>
2949
   *
2950
   * @return string <p>The resulting string</p>
2951
   */
2952
  public static function lcfirst($str)
2953
  {
2954
    return self::strtolower(self::substr($str, 0, 1)) . self::substr($str, 1);
0 ignored issues
show
Security Bug introduced by
It seems like self::substr($str, 0, 1) targeting voku\helper\UTF8::substr() can also be of type false; however, voku\helper\UTF8::strtolower() does only seem to accept string, did you maybe forget to handle an error condition?
Loading history...
2955 2
  }
2956
2957 2
  /**
2958
   * Strip whitespace or other characters from beginning of a UTF-8 string.
2959 2
   *
2960 2
   * @param string $str   <p>The string to be trimmed</p>
2961 2
   * @param string $chars <p>Optional characters to be stripped</p>
2962
   *
2963 2
   * @return string <p>The string with unwanted characters stripped from the left.</p>
2964
   */
2965 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...
2966
  {
2967
    $str = (string)$str;
2968
2969
    if (!isset($str[0])) {
2970
      return '';
2971
    }
2972
2973 1
    // Info: http://nadeausoftware.com/articles/2007/9/php_tip_how_strip_punctuation_characters_web_page#Unicodecharactercategories
2974
    if ($chars === INF || !$chars) {
2975 1
      return preg_replace('/^[\pZ\pC]+/u', '', $str);
2976
    }
2977
2978
    $chars = INF === $chars ? '\s' : self::rxClass($chars);
2979 1
2980
    return preg_replace("/^{$chars}+/u", '', $str);
2981
  }
2982
2983
  /**
2984
   * Returns the UTF-8 character with the maximum code point in the given data.
2985
   *
2986
   * @param mixed $arg <p>A UTF-8 encoded string or an array of such strings.</p>
2987
   *
2988
   * @return string <p>The character with the highest code point than others.</p>
2989
   */
2990 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...
2991 1
  {
2992
    if (is_array($arg)) {
2993 1
      $arg = implode($arg);
2994
    }
2995
2996
    return self::chr(max(self::codepoints($arg)));
2997
  }
2998
2999
  /**
3000
   * Calculates and returns the maximum number of bytes taken by any
3001
   * UTF-8 encoded character in the given string.
3002
   *
3003 4
   * @param string $str <p>The original Unicode string.</p>
3004
   *
3005 4
   * @return int <p>Max byte lengths of the given chars.</p>
3006
   */
3007 4
  public static function max_chr_width($str)
3008 1
  {
3009
    $bytes = self::chr_size_list($str);
3010
    if (count($bytes) > 0) {
3011 4
      return (int)max($bytes);
3012 1
    } else {
3013
      return 0;
3014
    }
3015 4
  }
3016 3
3017
  /**
3018
   * Checks whether mbstring is available on the server.
3019 3
   *
3020 3
   * @return bool <p><strong>true</strong> if available, <strong>false</strong> otherwise.</p>
3021
   */
3022
  public static function mbstring_loaded()
3023 2
  {
3024 2
    $return = extension_loaded('mbstring');
3025 2
3026
    if ($return === true) {
3027
      \mb_internal_encoding('UTF-8');
3028 2
    }
3029 2
3030 2
    return $return;
3031 2
  }
3032 2
3033 2
  /**
3034 2
   * Returns the UTF-8 character with the minimum code point in the given data.
3035 2
   *
3036 2
   * @param mixed $arg <strong>A UTF-8 encoded string or an array of such strings.</strong>
3037 2
   *
3038 2
   * @return string <p>The character with the lowest code point than others.</p>
3039 2
   */
3040 2 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...
3041 2
  {
3042 2
    if (is_array($arg)) {
3043
      $arg = implode($arg);
3044 2
    }
3045 2
3046 2
    return self::chr(min(self::codepoints($arg)));
3047
  }
3048 2
3049
  /**
3050 2
   * alias for "UTF8::normalize_encoding()"
3051
   *
3052
   * @see UTF8::normalize_encoding()
3053
   *
3054
   * @param string $encoding
3055
   *
3056
   * @return string
3057
   */
3058
  public static function normalizeEncoding($encoding)
3059
  {
3060 2
    return self::normalize_encoding($encoding);
3061
  }
3062 2
3063 2
  /**
3064
   * Normalize the encoding-"name" input.
3065 2
   *
3066 1
   * @param string $encoding <p>e.g.: ISO, UTF8, WINDOWS-1251 etc.</p>
3067 1
   *
3068 1
   * @return string <p>e.g.: ISO-8859-1, UTF-8, WINDOWS-1251 etc.</p>
3069
   */
3070 2
  public static function normalize_encoding($encoding)
3071
  {
3072
    static $staticNormalizeEncodingCache = array();
3073
3074
    if (!$encoding) {
3075
      return false;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return false; (false) is incompatible with the return type documented by voku\helper\UTF8::normalize_encoding of type 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...
3076
    }
3077
3078
    if ('UTF-8' === $encoding) {
3079
      return $encoding;
3080
    }
3081
3082
    if (in_array($encoding, self::$iconvEncoding, true)) {
3083 7
      return $encoding;
3084
    }
3085 7
3086 7
    if (isset($staticNormalizeEncodingCache[$encoding])) {
3087
      return $staticNormalizeEncodingCache[$encoding];
3088 7
    }
3089
3090 7
    $encodingOrig = $encoding;
3091
    $encoding = strtoupper($encoding);
3092 2
    $encodingUpperHelper = preg_replace('/[^a-zA-Z0-9\s]/', '', $encoding);
3093
3094 2
    $equivalences = array(
3095
        'ISO88591'    => 'ISO-8859-1',
3096 1
        'ISO8859'     => 'ISO-8859-1',
3097 1
        'ISO'         => 'ISO-8859-1',
3098
        'LATIN1'      => 'ISO-8859-1',
3099 2
        'LATIN'       => 'ISO-8859-1',
3100 2
        'WIN1252'     => 'ISO-8859-1',
3101
        'WINDOWS1252' => 'ISO-8859-1',
3102 7
        'UTF16'       => 'UTF-16',
3103 7
        'UTF32'       => 'UTF-32',
3104 1
        'UTF8'        => 'UTF-8',
3105 1
        'UTF'         => 'UTF-8',
3106
        'UTF7'        => 'UTF-7',
3107 7
        '8BIT'        => 'CP850',
3108 7
        'BINARY'      => 'CP850',
3109
    );
3110 7
3111
    if (!empty($equivalences[$encodingUpperHelper])) {
3112
      $encoding = $equivalences[$encodingUpperHelper];
3113
    }
3114
3115
    $staticNormalizeEncodingCache[$encodingOrig] = $encoding;
3116
3117
    return $encoding;
3118
  }
3119
3120
  /**
3121
   * Normalize some MS Word special characters.
3122
   *
3123
   * @param string $str <p>The string to be normalized.</p>
3124
   *
3125
   * @return string
3126
   */
3127
  public static function normalize_msword($str)
3128
  {
3129
    static $utf8MSWordKeys = null;
3130
    static $utf8MSWordValues = null;
3131
3132
    if ($utf8MSWordKeys === null) {
3133
      $utf8MSWordKeys = array_keys(self::$utf8MSWord);
3134
      $utf8MSWordValues = array_values(self::$utf8MSWord);
3135
    }
3136
3137
    return str_replace($utf8MSWordKeys, $utf8MSWordValues, $str);
3138
  }
3139
3140
  /**
3141
   * Normalize the whitespace.
3142
   *
3143
   * @param string $str                     <p>The string to be normalized.</p>
3144
   * @param bool   $keepNonBreakingSpace    [optional] <p>Set to true, to keep non-breaking-spaces.</p>
3145
   * @param bool   $keepBidiUnicodeControls [optional] <p>Set to true, to keep non-printable (for the web)
3146
   *                                        bidirectional text chars.</p>
3147
   *
3148
   * @return string
3149
   */
3150
  public static function normalize_whitespace($str, $keepNonBreakingSpace = false, $keepBidiUnicodeControls = false)
3151
  {
3152
    static $whitespaces = array();
3153
    static $bidiUniCodeControls = null;
3154
3155
    $cacheKey = (int)$keepNonBreakingSpace;
3156
3157
    if (!isset($whitespaces[$cacheKey])) {
3158
3159
      $whitespaces[$cacheKey] = self::$whitespaceTable;
3160
3161
      if ($keepNonBreakingSpace === true) {
3162
        /** @noinspection OffsetOperationsInspection */
3163 17
        unset($whitespaces[$cacheKey]['NO-BREAK SPACE']);
3164
      }
3165 17
3166 3
      $whitespaces[$cacheKey] = array_values($whitespaces[$cacheKey]);
3167
    }
3168
3169 16
    if ($keepBidiUnicodeControls === false) {
3170
      if ($bidiUniCodeControls === null) {
3171
        $bidiUniCodeControls = array_values(self::$bidiUniCodeControlsTable);
3172
      }
3173 16
3174
      $str = str_replace($bidiUniCodeControls, '', $str);
3175
    }
3176
3177
    return str_replace($whitespaces[$cacheKey], ' ', $str);
3178
  }
3179
3180 16
  /**
3181 16
   * Format a number with grouped thousands.
3182
   *
3183 16
   * @param float  $number
3184 3
   * @param int    $decimals
3185
   * @param string $dec_point
3186
   * @param string $thousands_sep
3187 15
   *
3188 10
   * @return string
3189
   *    *
3190
   * @deprecated Because this has nothing to do with UTF8. :/
3191 13
   */
3192 10
  public static function number_format($number, $decimals = 0, $dec_point = '.', $thousands_sep = ',')
3193
  {
3194
    $thousands_sep = (string)$thousands_sep;
3195 12
    $dec_point = (string)$dec_point;
3196
3197
    if (
3198
        isset($thousands_sep[1], $dec_point[1])
3199
        &&
3200
        Bootup::is_php('5.4') === true
3201
    ) {
3202
      return str_replace(
3203
          array(
3204
              '.',
3205
              ',',
3206
          ),
3207
          array(
3208
              $dec_point,
3209
              $thousands_sep,
3210
          ),
3211 1
          number_format($number, $decimals, '.', ',')
3212
      );
3213
    }
3214 1
3215
    return number_format($number, $decimals, $dec_point, $thousands_sep);
3216 1
  }
3217 1
3218 1
  /**
3219
   * Calculates Unicode code point of the given UTF-8 encoded character.
3220
   *
3221 1
   * INFO: opposite to UTF8::chr()
3222
   *
3223
   * @param string $chr <p>The character of which to calculate code point.<p/>
3224
   *
3225
   * @return int <p>
3226
   *             Unicode code point of the given character,<br />
3227
   *             0 on invalid UTF-8 byte sequence.
3228
   *             </p>
3229 41
   */
3230
  public static function ord($chr)
3231
  {
3232 41
    if (!$chr && $chr !== '0') {
3233
      return 0;
3234
    }
3235
3236
    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
3237
      self::checkForSupport();
3238
    }
3239
3240
    if (self::$support['intlChar'] === true) {
3241
      $tmpReturn = \IntlChar::ord($chr);
3242
      if ($tmpReturn) {
3243 1
        return $tmpReturn;
3244
      }
3245 1
    }
3246 1
3247
    // use static cache, if there is no support for "IntlChar"
3248
    static $cache = array();
3249 1
    if (isset($cache[$chr]) === true) {
3250 1
      return $cache[$chr];
3251 1
    }
3252
3253
    $chr_orig = $chr;
3254 1
    $chr = unpack('C*', substr($chr, 0, 4));
3255
    $a = $chr ? $chr[1] : 0;
3256
3257 1
    if (0xF0 <= $a && isset($chr[4])) {
3258
      return $cache[$chr_orig] = (($a - 0xF0) << 18) + (($chr[2] - 0x80) << 12) + (($chr[3] - 0x80) << 6) + $chr[4] - 0x80;
3259
    }
3260
3261 1
    if (0xE0 <= $a && isset($chr[3])) {
3262 1
      return $cache[$chr_orig] = (($a - 0xE0) << 12) + (($chr[2] - 0x80) << 6) + $chr[3] - 0x80;
3263 1
    }
3264
3265
    if (0xC0 <= $a && isset($chr[2])) {
3266 1
      return $cache[$chr_orig] = (($a - 0xC0) << 6) + $chr[2] - 0x80;
3267
    }
3268
3269 1
    return $cache[$chr_orig] = $a;
3270
  }
3271
3272
  /**
3273 1
   * Parses the string into an array (into the the second parameter).
3274
   *
3275 1
   * WARNING: Instead of "parse_str()" this method do not (re-)placing variables in the current scope,
3276 1
   *          if the second parameter is not set!
3277 1
   *
3278 1
   * @link http://php.net/manual/en/function.parse-str.php
3279 1
   *
3280
   * @param string $str    <p>The input string.</p>
3281
   * @param array  $result <p>The result will be returned into this reference parameter.</p>
3282
   *
3283
   * @return bool <p>Will return <strong>false</strong> if php can't parse the string and we haven't any $result.</p>
3284
   */
3285
  public static function parse_str($str, &$result)
3286
  {
3287
    // init
3288
    $str = self::clean($str);
3289 10
3290
    $return = \mb_parse_str($str, $result);
3291 10
    if ($return === false || empty($result)) {
3292 10
      return false;
3293 5
    }
3294 5
3295 10
    return true;
3296
  }
3297 10
3298
  /**
3299
   * Checks if \u modifier is available that enables Unicode support in PCRE.
3300
   *
3301
   * @return bool <p><strong>true</strong> if support is available, <strong>false</strong> otherwise.</p>
3302
   */
3303
  public static function pcre_utf8_support()
3304
  {
3305
    /** @noinspection PhpUsageOfSilenceOperatorInspection */
3306
    return (bool)@preg_match('//u', '');
3307
  }
3308
3309 5
  /**
3310
   * Create an array containing a range of UTF-8 characters.
3311 5
   *
3312
   * @param mixed $var1 <p>Numeric or hexadecimal code points, or a UTF-8 character to start from.</p>
3313
   * @param mixed $var2 <p>Numeric or hexadecimal code points, or a UTF-8 character to end at.</p>
3314
   *
3315
   * @return array
3316
   */
3317
  public static function range($var1, $var2)
3318
  {
3319
    if (!$var1 || !$var2) {
3320
      return array();
3321
    }
3322 1
3323 View Code Duplication
    if (ctype_digit((string)$var1)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
3324 1
      $start = (int)$var1;
3325 1
    } elseif (ctype_xdigit($var1)) {
3326 1
      $start = (int)self::hex_to_int($var1);
3327
    } else {
3328 1
      $start = self::ord($var1);
3329 1
    }
3330 1
3331 1
    if (!$start) {
3332 1
      return array();
3333
    }
3334 1
3335 View Code Duplication
    if (ctype_digit((string)$var2)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
3336
      $end = (int)$var2;
3337
    } elseif (ctype_xdigit($var2)) {
3338
      $end = (int)self::hex_to_int($var2);
3339
    } else {
3340
      $end = self::ord($var2);
3341
    }
3342
3343
    if (!$end) {
3344
      return array();
3345
    }
3346
3347
    return array_map(
3348
        array(
3349
            '\\voku\\helper\\UTF8',
3350 43
            'chr',
3351
        ),
3352
        range($start, $end)
3353 43
    );
3354
  }
3355
3356
  /**
3357 43
   * alias for "UTF8::remove_bom()"
3358 43
   *
3359 43
   * @see UTF8::remove_bom()
3360 43
   *
3361
   * @param string $str
3362 43
   *
3363
   * @return string
3364
   */
3365 43
  public static function removeBOM($str)
3366 43
  {
3367
    return self::remove_bom($str);
3368 43
  }
3369
3370
  /**
3371
   * Remove the BOM from UTF-8 / UTF-16 / UTF-32 strings.
3372
   *
3373
   * @param string $str <p>The input string.</p>
3374
   *
3375
   * @return string <p>String without UTF-BOM</p>
3376
   */
3377
  public static function remove_bom($str)
3378
  {
3379 43
    foreach (self::$bom as $bomString => $bomByteLength) {
3380
      if (0 === strpos($str, $bomString)) {
3381 43
        $str = substr($str, $bomByteLength);
3382
      }
3383 43
    }
3384 43
3385 43
    return $str;
3386
  }
3387 43
3388 43
  /**
3389 43
   * Removes duplicate occurrences of a string in another string.
3390
   *
3391 43
   * @param string          $str  <p>The base string.</p>
3392
   * @param string|string[] $what <p>String to search for in the base string.</p>
3393
   *
3394
   * @return string <p>The result string with removed duplicates.</p>
3395
   */
3396
  public static function remove_duplicates($str, $what = ' ')
3397
  {
3398
    if (is_string($what)) {
3399
      $what = array($what);
3400
    }
3401
3402 23
    if (is_array($what)) {
3403
      foreach ($what as $item) {
3404 23
        $str = preg_replace('/(' . preg_quote($item, '/') . ')+/', $item, $str);
3405
      }
3406 23
    }
3407 5
3408
    return $str;
3409
  }
3410
3411 19
  /**
3412 3
   * Remove invisible characters from a string.
3413
   *
3414
   * e.g.: This prevents sandwiching null characters between ascii characters, like Java\0script.
3415 18
   *
3416
   * copy&past from https://github.com/bcit-ci/CodeIgniter/blob/develop/system/core/Common.php
3417 18
   *
3418
   * @param string $str
3419
   * @param bool   $url_encoded
3420
   * @param string $replacement
3421
   *
3422
   * @return string
3423
   */
3424
  public static function remove_invisible_characters($str, $url_encoded = true, $replacement = '')
3425
  {
3426
    // init
3427
    $non_displayables = array();
3428 45
3429
    // every control character except newline (dec 10),
3430 45
    // carriage return (dec 13) and horizontal tab (dec 09)
0 ignored issues
show
Unused Code Comprehensibility introduced by
37% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
3431
    if ($url_encoded) {
3432 45
      $non_displayables[] = '/%0[0-8bcef]/'; // url encoded 00-08, 11, 12, 14, 15
0 ignored issues
show
Unused Code Comprehensibility introduced by
50% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
3433
      $non_displayables[] = '/%1[0-9a-f]/'; // url encoded 16-31
3434 45
    }
3435 34
3436
    $non_displayables[] = '/[\x00-\x08\x0B\x0C\x0E-\x1F\x7F]+/S'; // 00-08, 11, 12, 14-31, 127
0 ignored issues
show
Unused Code Comprehensibility introduced by
62% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
3437
3438 17
    do {
3439
      $str = preg_replace($non_displayables, $replacement, $str, -1, $count);
3440
    } while ($count !== 0);
3441 17
3442 17
    return $str;
3443
  }
3444 17
3445 17
  /**
3446 17
   * Replace the diamond question mark (�) with the replacement.
3447 2
   *
3448 2
   * @param string $str
3449
   * @param string $unknown
3450
   *
3451 17
   * @return string
3452
   */
3453 17
  public static function replace_diamond_question_mark($str, $unknown = '?')
3454 17
  {
3455 17
    return str_replace(
3456
        array(
3457 17
            "\xEF\xBF\xBD",
3458 17
            '�',
3459 17
        ),
3460
        array(
3461
            $unknown,
3462
            $unknown,
3463 17
        ),
3464
        $str
3465 17
    );
3466
  }
3467
3468
  /**
3469
   * Strip whitespace or other characters from end of a UTF-8 string.
3470
   *
3471
   * @param string $str   <p>The string to be trimmed.</p>
3472
   * @param string $chars <p>Optional characters to be stripped.</p>
3473
   *
3474
   * @return string <p>The string with unwanted characters stripped from the right.</p>
3475
   */
3476 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...
3477
  {
3478
    $str = (string)$str;
3479
3480
    if (!isset($str[0])) {
3481
      return '';
3482
    }
3483
3484
    // Info: http://nadeausoftware.com/articles/2007/9/php_tip_how_strip_punctuation_characters_web_page#Unicodecharactercategories
3485
    if ($chars === INF || !$chars) {
3486 1
      return preg_replace('/[\pZ\pC]+$/u', '', $str);
3487
    }
3488 1
3489 1
    $chars = INF === $chars ? '\s' : self::rxClass($chars);
3490
3491
    return preg_replace("/{$chars}+$/u", '', $str);
3492
  }
3493
3494 1
  /**
3495 1
   * rxClass
3496 1
   *
3497 1
   * @param string $s
3498
   * @param string $class
3499
   *
3500 1
   * @return string
3501
   */
3502
  private static function rxClass($s, $class = '')
3503
  {
3504
    static $rxClassCache = array();
3505
3506
    $cacheKey = $s . $class;
3507
3508
    if (isset($rxClassCache[$cacheKey])) {
3509
      return $rxClassCache[$cacheKey];
3510
    }
3511
3512 35
    $class = array($class);
3513
3514 35
    /** @noinspection SuspiciousLoopInspection */
3515
    foreach (self::str_split($s) as $s) {
3516 35
      if ('-' === $s) {
3517 2
        $class[0] = '-' . $class[0];
3518
      } elseif (!isset($s[2])) {
3519
        $class[0] .= preg_quote($s, '/');
3520
      } elseif (1 === self::strlen($s)) {
3521 35
        $class[0] .= $s;
3522 35
      } else {
3523
        $class[] = $s;
3524 35
      }
3525
    }
3526
3527
    if ($class[0]) {
3528 35
      $class[0] = '[' . $class[0] . ']';
3529
    }
3530 35
3531 6
    if (1 === count($class)) {
3532 6
      $return = $class[0];
3533
    } else {
3534 35
      $return = '(?:' . implode('|', $class) . ')';
3535 35
    }
3536 35
3537 35
    $rxClassCache[$cacheKey] = $return;
3538 35
3539
    return $return;
3540 35
  }
3541
3542
  /**
3543
   * WARNING: Echo native UTF8-Support libs, e.g. for debugging.
3544
   */
3545
  public static function showSupport()
3546
  {
3547
    foreach (self::$support as $utf8Support) {
3548
      echo $utf8Support . "\n<br>";
3549
    }
3550
  }
3551
3552
  /**
3553
   * Converts a UTF-8 character to HTML Numbered Entity like "&#123;".
3554
   *
3555
   * @param string $char           <p>The Unicode character to be encoded as numbered entity.</p>
3556
   * @param bool   $keepAsciiChars <p>Set to <strong>true</strong> to keep ASCII chars.</>
3557
   *
3558
   * @return string <p>The HTML numbered entity.</p>
3559
   */
3560
  public static function single_chr_html_encode($char, $keepAsciiChars = false)
3561
  {
3562
    if (!$char) {
3563
      return '';
3564
    }
3565
3566
    if (
3567
        $keepAsciiChars === true
3568
        &&
3569
        self::isAscii($char) === true
3570
    ) {
3571
      return $char;
3572 35
    }
3573 5
3574
    return '&#' . self::ord($char) . ';';
3575 5
  }
3576 5
3577
  /**
3578
   * Convert a string to an array of Unicode characters.
3579 35
   *
3580
   * @param string  $str       <p>The string to split into array.</p>
3581
   * @param int     $length    [optional] <p>Max character length of each array element.</p>
3582
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
3583 35
   *
3584
   * @return string[] <p>An array containing chunks of the string.</p>
3585
   */
3586
  public static function split($str, $length = 1, $cleanUtf8 = false)
3587
  {
3588
    $str = (string)$str;
3589
3590
    if (!isset($str[0])) {
3591
      return array();
3592
    }
3593
3594
    // init
3595
    $str = (string)$str;
3596 12
    $ret = array();
3597
3598
    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
3599
      self::checkForSupport();
3600
    }
3601
3602 12
    if (self::$support['pcre_utf8'] === true) {
3603 2
3604 1
      if ($cleanUtf8 === true) {
3605 2
        $str = self::clean($str);
3606 1
      }
3607 2
3608
      preg_match_all('/./us', $str, $retArray);
3609 2
      if (isset($retArray[0])) {
3610
        $ret = $retArray[0];
3611
      }
3612 2
      unset($retArray);
3613
3614
    } else {
3615
3616
      // fallback
3617
3618 12
      $len = strlen($str);
3619 3
3620
      /** @noinspection ForeachInvariantsInspection */
3621
      for ($i = 0; $i < $len; $i++) {
3622
        if (($str[$i] & "\x80") === "\x00") {
3623
          $ret[] = $str[$i];
3624
        } elseif ((($str[$i] & "\xE0") === "\xC0") && isset($str[$i + 1])) {
3625
          if (($str[$i + 1] & "\xC0") === "\x80") {
3626 12
            $ret[] = $str[$i] . $str[$i + 1];
3627 9
3628
            $i++;
3629
          }
3630 View Code Duplication
        } elseif ((($str[$i] & "\xF0") === "\xE0") && isset($str[$i + 2])) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
3631
          if ((($str[$i + 1] & "\xC0") === "\x80") && (($str[$i + 2] & "\xC0") === "\x80")) {
3632
            $ret[] = $str[$i] . $str[$i + 1] . $str[$i + 2];
3633
3634
            $i += 2;
3635
          }
3636 6
        } elseif ((($str[$i] & "\xF8") === "\xF0") && isset($str[$i + 3])) {
3637 6 View Code Duplication
          if ((($str[$i + 1] & "\xC0") === "\x80") && (($str[$i + 2] & "\xC0") === "\x80") && (($str[$i + 3] & "\xC0") === "\x80")) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
3638 6
            $ret[] = $str[$i] . $str[$i + 1] . $str[$i + 2] . $str[$i + 3];
3639 6
3640 6
            $i += 3;
3641 6
          }
3642 6
        }
3643 6
      }
3644 6
    }
3645 6
3646 6
    if ($length > 1) {
3647 6
      $ret = array_chunk($ret, $length);
3648 6
3649 6
      $ret = array_map('implode', $ret);
3650 6
    }
3651 6
3652 6
    /** @noinspection OffsetOperationsInspection */
3653 6
    if (isset($ret[0]) && $ret[0] === '') {
3654 6
      return array();
3655 6
    }
3656 6
3657
    return $ret;
3658 6
  }
3659 6
3660 6
  /**
3661
   * Optimized "\mb_detect_encoding()"-function -> with support for UTF-16 and UTF-32.
3662
   *
3663
   * @param string $str <p>The input string.</p>
3664
   *
3665
   * @return false|string <p>
3666
   *                      The detected string-encoding e.g. UTF-8 or UTF-16BE,<br />
3667
   *                      otherwise it will return false.
3668
   *                      </p>
3669
   */
3670
  public static function str_detect_encoding($str)
3671
  {
3672
    //
3673
    // 1.) check binary strings (010001001...) like UTF-16 / UTF-32
3674
    //
3675
3676
    if (self::is_binary($str)) {
3677
      if (self::is_utf16($str) === 1) {
3678
        return 'UTF-16LE';
3679
      } elseif (self::is_utf16($str) === 2) {
3680
        return 'UTF-16BE';
3681
      } elseif (self::is_utf32($str) === 1) {
3682
        return 'UTF-32LE';
3683
      } elseif (self::is_utf32($str) === 2) {
3684
        return 'UTF-32BE';
3685
      }
3686
    }
3687
3688
    //
3689
    // 2.) simple check for ASCII chars
3690
    //
3691
3692
    if (self::is_ascii($str) === true) {
3693
      return 'ASCII';
3694
    }
3695
3696
    //
3697
    // 3.) simple check for UTF-8 chars
3698
    //
3699
3700
    if (self::is_utf8($str) === true) {
3701
      return 'UTF-8';
3702
    }
3703
3704 13
    //
3705
    // 4.) check via "\mb_detect_encoding()"
3706 13
    //
3707
    // INFO: UTF-16, UTF-32, UCS2 and UCS4, encoding detection will fail always with "\mb_detect_encoding()"
3708
3709 13
    $detectOrder = array(
3710 13
        'ISO-8859-1',
3711 1
        'ISO-8859-2',
3712 1
        'ISO-8859-3',
3713 12
        'ISO-8859-4',
3714
        'ISO-8859-5',
3715 13
        'ISO-8859-6',
3716
        'ISO-8859-7',
3717 13
        'ISO-8859-8',
3718 13
        'ISO-8859-9',
3719
        'ISO-8859-10',
3720 13
        'ISO-8859-13',
3721
        'ISO-8859-14',
3722
        'ISO-8859-15',
3723
        'ISO-8859-16',
3724
        'WINDOWS-1251',
3725
        'WINDOWS-1252',
3726
        'WINDOWS-1254',
3727
        'ISO-2022-JP',
3728
        'JIS',
3729
        'EUC-JP',
3730
    );
3731
3732 1
    $encoding = \mb_detect_encoding($str, $detectOrder, true);
3733
    if ($encoding) {
3734 1
      return $encoding;
3735
    }
3736 1
3737
    //
3738
    // 5.) check via "iconv()"
3739
    //
3740 1
3741
    $md5 = md5($str);
3742 1
    foreach (self::$iconvEncoding as $encodingTmp) {
3743
      # INFO: //IGNORE and //TRANSLIT still throw notice
3744
      /** @noinspection PhpUsageOfSilenceOperatorInspection */
3745
      if (md5(@iconv($encodingTmp, $encodingTmp, $str)) === $md5) {
3746 1
        return $encodingTmp;
3747 1
      }
3748
    }
3749
3750 1
    return false;
3751 1
  }
3752 1
3753 1
  /**
3754
   * Case-insensitive and UTF-8 safe version of <function>str_replace</function>.
3755 1
   *
3756
   * @link  http://php.net/manual/en/function.str-ireplace.php
3757
   *
3758 1
   * @param mixed $search  <p>
3759
   *                       Every replacement with search array is
3760
   *                       performed on the result of previous replacement.
3761 1
   *                       </p>
3762
   * @param mixed $replace <p>
3763
   *                       </p>
3764
   * @param mixed $subject <p>
3765
   *                       If subject is an array, then the search and
3766
   *                       replace is performed with every entry of
3767
   *                       subject, and the return value is an array as
3768
   *                       well.
3769
   *                       </p>
3770
   * @param int   $count   [optional] <p>
3771
   *                       The number of matched and replaced needles will
3772
   *                       be returned in count which is passed by
3773
   *                       reference.
3774
   *                       </p>
3775
   *
3776
   * @return mixed <p>A string or an array of replacements.</p>
3777 2
   */
3778
  public static function str_ireplace($search, $replace, $subject, &$count = null)
3779 2
  {
3780
    $search = (array)$search;
3781 2
3782 2
    /** @noinspection AlterInForeachInspection */
3783
    foreach ($search as &$s) {
3784 2
      if ('' === $s .= '') {
3785
        $s = '/^(?<=.)$/';
3786
      } else {
3787 2
        $s = '/' . preg_quote($s, '/') . '/ui';
3788 2
      }
3789 2
    }
3790 2
3791 2
    $subject = preg_replace($search, $replace, $subject, -1, $replace);
3792
    $count = $replace; // used as reference parameter
3793 2
3794 2
    return $subject;
3795 2
  }
3796 2
3797 2
  /**
3798 2
   * Limit the number of characters in a string, but also after the next word.
3799
   *
3800 2
   * @param string $str
3801 2
   * @param int    $length
3802 2
   * @param string $strAddOn
3803 2
   *
3804 2
   * @return string
3805 2
   */
3806
  public static function str_limit_after_word($str, $length = 100, $strAddOn = '...')
3807 2
  {
3808
    $str = (string)$str;
3809
3810 2
    if (!isset($str[0])) {
3811
      return '';
3812
    }
3813
3814
    $length = (int)$length;
3815
3816
    if (self::strlen($str) <= $length) {
3817
      return $str;
3818
    }
3819
3820
    if (self::substr($str, $length - 1, 1) === ' ') {
3821
      return self::substr($str, 0, $length - 1) . $strAddOn;
3822
    }
3823
3824
    $str = self::substr($str, 0, $length);
3825
    $array = explode(' ', $str);
3826
    array_pop($array);
3827
    $new_str = implode(' ', $array);
3828
3829
    if ($new_str === '') {
3830
      $str = self::substr($str, 0, $length - 1) . $strAddOn;
0 ignored issues
show
Security Bug introduced by
It seems like $str can also be of type false; however, voku\helper\UTF8::substr() does only seem to accept string, did you maybe forget to handle an error condition?
Loading history...
3831 1
    } else {
3832
      $str = $new_str . $strAddOn;
3833 1
    }
3834
3835 1
    return $str;
3836
  }
3837
3838
  /**
3839
   * Pad a UTF-8 string to given length with another string.
3840
   *
3841
   * @param string $str        <p>The input string.</p>
3842
   * @param int    $pad_length <p>The length of return string.</p>
3843
   * @param string $pad_string [optional] <p>String to use for padding the input string.</p>
3844
   * @param int    $pad_type   [optional] <p>
3845
   *                           Can be <strong>STR_PAD_RIGHT</strong> (default),
3846
   *                           <strong>STR_PAD_LEFT</strong> or <strong>STR_PAD_BOTH</strong>
3847
   *                           </p>
3848
   *
3849
   * @return string <strong>Returns the padded string</strong>
3850
   */
3851
  public static function str_pad($str, $pad_length, $pad_string = ' ', $pad_type = STR_PAD_RIGHT)
3852
  {
3853
    $str_length = self::strlen($str);
3854
3855
    if (
3856
        is_int($pad_length) === true
3857
        &&
3858
        $pad_length > 0
3859
        &&
3860
        $pad_length >= $str_length
3861
    ) {
3862
      $ps_length = self::strlen($pad_string);
3863
3864
      $diff = $pad_length - $str_length;
3865
3866
      switch ($pad_type) {
3867 12 View Code Duplication
        case STR_PAD_LEFT:
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
3868
          $pre = str_repeat($pad_string, (int)ceil($diff / $ps_length));
3869 12
          $pre = self::substr($pre, 0, $diff);
3870
          $post = '';
3871
          break;
3872
3873
        case STR_PAD_BOTH:
3874
          $pre = str_repeat($pad_string, (int)ceil($diff / $ps_length / 2));
3875
          $pre = self::substr($pre, 0, (int)$diff / 2);
3876
          $post = str_repeat($pad_string, (int)ceil($diff / $ps_length / 2));
3877
          $post = self::substr($post, 0, (int)ceil($diff / 2));
3878
          break;
3879 1
3880
        case STR_PAD_RIGHT:
3881 1 View Code Duplication
        default:
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
3882
          $post = str_repeat($pad_string, (int)ceil($diff / $ps_length));
3883 1
          $post = self::substr($post, 0, $diff);
3884
          $pre = '';
3885 1
      }
3886
3887
      return $pre . $str . $post;
3888
    }
3889
3890
    return $str;
3891
  }
3892
3893
  /**
3894
   * Repeat a string.
3895
   *
3896
   * @param string $str        <p>
3897 1
   *                           The string to be repeated.
3898
   *                           </p>
3899 1
   * @param int    $multiplier <p>
3900
   *                           Number of time the input string should be
3901 1
   *                           repeated.
3902 1
   *                           </p>
3903 1
   *                           <p>
3904
   *                           multiplier has to be greater than or equal to 0.
3905 1
   *                           If the multiplier is set to 0, the function
3906 1
   *                           will return an empty string.
3907 1
   *                           </p>
3908 1
   *
3909
   * @return string <p>The repeated string.</p>
3910
   */
3911 1
  public static function str_repeat($str, $multiplier)
3912
  {
3913
    $str = self::filter($str);
3914
3915
    return str_repeat($str, $multiplier);
3916
  }
3917
3918
  /**
3919
   * INFO: This is only a wrapper for "str_replace()"  -> the original functions is already UTF-8 safe.
3920
   *
3921
   * Replace all occurrences of the search string with the replacement string
3922 20
   *
3923
   * @link http://php.net/manual/en/function.str-replace.php
3924
   *
3925 20
   * @param mixed $search  <p>
3926
   *                       The value being searched for, otherwise known as the needle.
3927 20
   *                       An array may be used to designate multiple needles.
3928
   *                       </p>
3929
   * @param mixed $replace <p>
3930
   *                       The replacement value that replaces found search
3931 20
   *                       values. An array may be used to designate multiple replacements.
3932 20
   *                       </p>
3933
   * @param mixed $subject <p>
3934 20
   *                       The string or array being searched and replaced on,
3935 20
   *                       otherwise known as the haystack.
3936
   *                       </p>
3937
   *                       <p>
3938 1
   *                       If subject is an array, then the search and
3939 1
   *                       replace is performed with every entry of
3940
   *                       subject, and the return value is an array as
3941
   *                       well.
3942 1
   *                       </p>
3943 1
   * @param int   $count   [optional] If passed, this will hold the number of matched and replaced needles.
3944 1
   *
3945 1
   * @return mixed <p>This function returns a string or an array with the replaced values.</p>
3946 1
   */
3947
  public static function str_replace($search, $replace, $subject, &$count = null)
3948 1
  {
3949
    return str_replace($search, $replace, $subject, $count);
3950 1
  }
3951
3952
  /**
3953
   * Shuffles all the characters in the string.
3954
   *
3955
   * @param string $str <p>The input string</p>
3956
   *
3957
   * @return string <p>The shuffled string.</p>
3958
   */
3959
  public static function str_shuffle($str)
3960 1
  {
3961
    $array = self::split($str);
3962 1
3963
    shuffle($array);
3964 1
3965
    return implode('', $array);
3966 1
  }
3967
3968
  /**
3969
   * Sort all characters according to code points.
3970
   *
3971
   * @param string $str    <p>A UTF-8 string.</p>
3972
   * @param bool   $unique <p>Sort unique. If <strong>true</strong>, repeated characters are ignored.</p>
3973
   * @param bool   $desc   <p>If <strong>true</strong>, will sort characters in reverse code point order.</p>
3974
   *
3975
   * @return string <p>String of sorted characters.</p>
3976
   */
3977
  public static function str_sort($str, $unique = false, $desc = false)
3978
  {
3979 7
    $array = self::codepoints($str);
3980
3981 7
    if ($unique) {
3982
      $array = array_flip(array_flip($array));
3983
    }
3984
3985
    if ($desc) {
3986
      arsort($array);
3987
    } else {
3988
      asort($array);
3989
    }
3990
3991
    return self::string($array);
3992
  }
3993
3994
  /**
3995
   * Split a string into an array.
3996
   *
3997
   * @param string $str
3998 1
   * @param int    $len
3999
   *
4000 1
   * @return array
4001 1
   */
4002
  public static function str_split($str, $len = 1)
4003 1
  {
4004
    // init
4005 1
    $len = (int)$len;
4006
    $str = (string)$str;
4007 1
4008 1
    if (!isset($str[0])) {
4009 1
      return array();
4010 1
    }
4011
4012 1
    if ($len < 1) {
4013
      return str_split($str, $len);
4014 1
    }
4015 1
4016 1
    preg_match_all('/' . Grapheme::GRAPHEME_CLUSTER_RX . '/u', $str, $a);
4017 1
    $a = $a[0];
4018 1
4019 1
    if ($len === 1) {
4020
      return $a;
4021 1
    }
4022
4023 1
    $arrayOutput = array();
4024
    $p = -1;
4025
4026
    /** @noinspection PhpForeachArrayIsUsedAsValueInspection */
4027 1
    foreach ($a as $l => $a) {
4028
      if ($l % $len) {
4029
        $arrayOutput[$p] .= $a;
4030
      } else {
4031
        $arrayOutput[++$p] = $a;
4032
      }
4033
    }
4034
4035
    return $arrayOutput;
4036
  }
4037
4038
  /**
4039
   * Get a binary representation of a specific string.
4040
   *
4041
   * @param string $str <p>The input string.</p>
4042
   *
4043
   * @return string
4044 9
   */
4045
  public static function str_to_binary($str)
4046 9
  {
4047
    $str = (string)$str;
4048
4049
    $value = unpack('H*', $str);
4050
4051
    return base_convert($value[1], 16, 2);
4052
  }
4053
4054
  /**
4055
   * alias for "UTF8::to_ascii()"
4056
   *
4057
   * @see UTF8::to_ascii()
4058
   *
4059
   * @param string $str
4060
   * @param string $unknown
4061 12
   * @param bool   $strict
4062
   *
4063 12
   * @return string
4064 11
   */
4065 11
  public static function str_transliterate($str, $unknown = '?', $strict = false)
4066 12
  {
4067
    return self::to_ascii($str, $unknown, $strict);
4068
  }
4069
4070
  /**
4071
   * Counts number of words in the UTF-8 string.
4072
   *
4073
   * @param string $str      <p>The input string.</p>
4074
   * @param int    $format   [optional] <p>
4075
   *                         <strong>0</strong> => return a number of words (default)<br />
4076
   *                         <strong>1</strong> => return an array of words<br />
4077
   *                         <strong>2</strong> => return an array of words with word-offset as key
4078
   *                         </p>
4079 8
   * @param string $charlist [optional] <p>Additional chars that contains to words and do not start a new word.</p>
4080
   *
4081 8
   * @return array|int <p>The number of words in the string</p>
4082 1
   */
4083
  public static function str_word_count($str, $format = 0, $charlist = '')
4084
  {
4085 7
    $charlist = self::rxClass($charlist, '\pL');
4086 2
    $strParts = \preg_split("/({$charlist}+(?:[\p{Pd}’']{$charlist}+)*)/u", $str, -1, PREG_SPLIT_DELIM_CAPTURE);
4087 2
4088 5
    $len = count($strParts);
4089
4090
    if ($format === 1) {
4091 7
4092
      $numberOfWords = array();
4093 7
      for ($i = 1; $i < $len; $i += 2) {
4094
        $numberOfWords[] = $strParts[$i];
4095 1
      }
4096
4097
    } elseif ($format === 2) {
4098
4099
      $numberOfWords = array();
4100
      $offset = self::strlen($strParts[0]);
4101
      for ($i = 1; $i < $len; $i += 2) {
4102
        $numberOfWords[$offset] = $strParts[$i];
4103
        $offset += self::strlen($strParts[$i]) + self::strlen($strParts[$i + 1]);
4104
      }
4105
4106
    } else {
4107
4108 2
      $numberOfWords = ($len - 1) / 2;
4109
4110 2
    }
4111 2
4112
    return $numberOfWords;
4113 2
  }
4114 2
4115 2
  /**
4116
   * Case-insensitive string comparison.
4117 2
   *
4118 2
   * INFO: Case-insensitive version of UTF8::strcmp()
4119
   *
4120
   * @param string $str1
4121
   * @param string $str2
4122
   *
4123
   * @return int <p>
4124
   *             <strong>&lt; 0</strong> if str1 is less than str2;<br />
4125
   *             <strong>&gt; 0</strong> if str1 is greater than str2,<br />
4126
   *             <strong>0</strong> if they are equal.
4127
   *             </p>
4128
   */
4129
  public static function strcasecmp($str1, $str2)
4130
  {
4131
    return self::strcmp(self::strtocasefold($str1), self::strtocasefold($str2));
4132
  }
4133
4134
  /**
4135
   * alias for "UTF8::strstr()"
4136
   *
4137
   * @see UTF8::strstr()
4138
   *
4139
   * @param string  $haystack
4140
   * @param string  $needle
4141
   * @param bool    $before_needle
4142 3
   * @param string  $encoding
4143
   * @param boolean $cleanUtf8
4144 3
   *
4145 3
   * @return string|false
4146 3
   */
4147
  public static function strchr($haystack, $needle, $before_needle = false, $encoding = 'UTF-8', $cleanUtf8 = false)
4148 3
  {
4149
    return self::strstr($haystack, $needle, $before_needle, $encoding, $cleanUtf8);
4150 3
  }
4151
4152
  /**
4153
   * Case-sensitive string comparison.
4154
   *
4155
   * @param string $str1
4156
   * @param string $str2
4157
   *
4158
   * @return int  <p>
4159
   *              <strong>&lt; 0</strong> if str1 is less than str2<br />
4160
   *              <strong>&gt; 0</strong> if str1 is greater than str2<br />
4161
   *              <strong>0</strong> if they are equal.
4162
   *              </p>
4163
   */
4164
  public static function strcmp($str1, $str2)
4165
  {
4166
    return $str1 . '' === $str2 . '' ? 0 : strcmp(
4167
        \Normalizer::normalize($str1, \Normalizer::NFD),
4168
        \Normalizer::normalize($str2, \Normalizer::NFD)
4169
    );
4170
  }
4171
4172 2
  /**
4173
   * Find length of initial segment not matching mask.
4174
   *
4175 2
   * @param string $str
4176
   * @param string $charList
4177 2
   * @param int    $offset
4178
   * @param int    $length
4179
   *
4180
   * @return int|null
4181
   */
4182
  public static function strcspn($str, $charList, $offset = 0, $length = 2147483647)
4183
  {
4184
    if ('' === $charList .= '') {
4185
      return null;
4186
    }
4187
4188
    if ($offset || 2147483647 !== $length) {
4189
      $str = (string)self::substr($str, $offset, $length);
4190
    }
4191
4192
    $str = (string)$str;
4193
    if (!isset($str[0])) {
4194
      return null;
4195
    }
4196
4197
    if (preg_match('/^(.*?)' . self::rxClass($charList) . '/us', $str, $length)) {
4198
      /** @noinspection OffsetOperationsInspection */
4199
      return self::strlen($length[1]);
4200
    }
4201
4202
    return self::strlen($str);
4203
  }
4204 8
4205
  /**
4206 8
   * alias for "UTF8::stristr()"
4207 8
   *
4208
   * @see UTF8::stristr()
4209 8
   *
4210 3
   * @param string  $haystack
4211
   * @param string  $needle
4212
   * @param bool    $before_needle
4213 7
   * @param string  $encoding
4214 1
   * @param boolean $cleanUtf8
4215 1
   *
4216 1
   * @return string|false
4217
   */
4218
  public static function strichr($haystack, $needle, $before_needle = false, $encoding = 'UTF-8', $cleanUtf8 = false)
4219
  {
4220 7
    return self::stristr($haystack, $needle, $before_needle, $encoding, $cleanUtf8);
4221 1
  }
4222 7
4223 7
  /**
4224 7
   * Create a UTF-8 string from code points.
4225
   *
4226
   * INFO: opposite to UTF8::codepoints()
4227
   *
4228 7
   * @param array $array <p>Integer or Hexadecimal codepoints.</p>
4229
   *
4230
   * @return string <p>UTF-8 encoded string.</p>
4231
   */
4232
  public static function string(array $array)
4233
  {
4234
    return implode(
4235
        array_map(
4236
            array(
4237
                '\\voku\\helper\\UTF8',
4238
                'chr',
4239
            ),
4240
            $array
4241
        )
4242
    );
4243
  }
4244 8
4245
  /**
4246 8
   * Checks if string starts with "BOM" (Byte Order Mark Character) character.
4247 2
   *
4248
   * @param string $str <p>The input string.</p>
4249
   *
4250 6
   * @return bool <p><strong>true</strong> if the string has BOM at the start, <strong>false</strong> otherwise.</p>
4251
   */
4252
  public static function string_has_bom($str)
4253
  {
4254 6
    foreach (self::$bom as $bomString => $bomByteLength) {
4255
      if (0 === strpos($str, $bomString)) {
4256
        return true;
4257
      }
4258
    }
4259
4260
    return false;
4261
  }
4262
4263
  /**
4264
   * Strip HTML and PHP tags from a string + clean invalid UTF-8.
4265
   *
4266
   * @link http://php.net/manual/en/function.strip-tags.php
4267
   *
4268
   * @param string $str            <p>
4269 62
   *                               The input string.
4270
   *                               </p>
4271 62
   * @param string $allowable_tags [optional] <p>
4272
   *                               You can use the optional second parameter to specify tags which should
4273 62
   *                               not be stripped.
4274 4
   *                               </p>
4275
   *                               <p>
4276
   *                               HTML comments and PHP tags are also stripped. This is hardcoded and
4277
   *                               can not be changed with allowable_tags.
4278
   *                               </p>
4279 61
   *
4280 1
   * @return string <p>The stripped string.</p>
4281 61
   */
4282 61
  public static function strip_tags($str, $allowable_tags = null)
4283 61
  {
4284 1
    // clean broken utf8
4285
    $str = self::clean($str);
4286
4287
    return strip_tags($str, $allowable_tags);
4288 61
  }
4289 61
4290
  /**
4291
   * Finds position of first occurrence of a string within another, case insensitive.
4292
   *
4293 61
   * @link http://php.net/manual/en/function.mb-stripos.php
4294 2
   *
4295 2
   * @param string  $haystack  <p>
4296
   *                           The string from which to get the position of the first occurrence
4297 61
   *                           of needle
4298
   *                           </p>
4299
   * @param string  $needle    <p>
4300
   *                           The string to find in haystack
4301
   *                           </p>
4302
   * @param int     $offset    [optional] <p>
4303
   *                           The position in haystack
4304
   *                           to start searching
4305
   *                           </p>
4306
   * @param string  $encoding  [optional] <p>Set the charset for e.g. "\mb_" function.</p>
4307
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
4308
   *
4309
   * @return int|false <p>
4310
   *                   Return the numeric position of the first occurrence of needle in the haystack string,<br />
4311
   *                   or false if needle is not found.
4312 1
   *                   </p>
4313
   */
4314 1
  public static function stripos($haystack, $needle, $offset = null, $encoding = 'UTF-8', $cleanUtf8 = false)
4315
  {
4316
    $haystack = (string)$haystack;
4317
    $needle = (string)$needle;
4318
4319
    if (!isset($haystack[0], $needle[0])) {
4320
      return false;
4321
    }
4322
4323
    if ($cleanUtf8 === true) {
4324
      $haystack = self::clean($haystack);
4325
      $needle = self::clean($needle);
4326
    }
4327
4328 View Code Duplication
    if (
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
4329
        $encoding === 'UTF-8'
4330
        ||
4331 2
        $encoding === true || $encoding === false // INFO: the "bool"-check is only a fallback for old versions
4332
    ) {
4333 2
      $encoding = 'UTF-8';
4334
    } else {
4335
      $encoding = self::normalize_encoding($encoding);
4336
    }
4337
4338
    return \mb_stripos($haystack, $needle, $offset, $encoding);
4339
  }
4340
4341
  /**
4342
   * Returns all of haystack starting from and including the first occurrence of needle to the end.
4343
   *
4344
   * @param string  $haystack      <p>The input string. Must be valid UTF-8.</p>
4345
   * @param string  $needle        <p>The string to look for. Must be valid UTF-8.</p>
4346
   * @param bool    $before_needle [optional] <p>
4347
   *                               If <b>TRUE</b>, grapheme_strstr() returns the part of the
4348
   *                               haystack before the first occurrence of the needle (excluding the needle).
4349 1
   *                               </p>
4350
   * @param string  $encoding      [optional] <p>Set the charset for e.g. "\mb_" function</p>
4351 1
   * @param boolean $cleanUtf8     [optional] <p>Clean non UTF-8 chars from the string.</p>
4352
   *
4353
   * @return false|string A sub-string,<br />or <strong>false</strong> if needle is not found.
4354
   */
4355
  public static function stristr($haystack, $needle, $before_needle = false, $encoding = 'UTF-8', $cleanUtf8 = false)
4356
  {
4357
    if ('' === $needle .= '') {
4358
      return false;
4359
    }
4360
4361
    if ($encoding !== 'UTF-8') {
4362
      $encoding = self::normalize_encoding($encoding);
4363
    }
4364
4365
    if ($cleanUtf8 === true) {
4366
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
4367 2
      // if invalid characters are found in $haystack before $needle
4368
      $needle = self::clean($needle);
4369 2
      $haystack = self::clean($haystack);
4370 2
    }
4371
4372 2
    return \mb_stristr($haystack, $needle, $before_needle, $encoding);
4373
  }
4374
4375
  /**
4376
   * Get the string length, not the byte-length!
4377
   *
4378
   * @link     http://php.net/manual/en/function.mb-strlen.php
4379
   *
4380
   * @param string  $str       <p>The string being checked for length.</p>
4381
   * @param string  $encoding  [optional] <p>Set the charset for e.g. "\mb_" function.</p>
4382
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
4383
   *
4384
   * @return int <p>The number of characters in the string $str having character encoding $encoding. (One multi-byte
4385 1
   *             character counted as +1)</p>
4386
   */
4387 1
  public static function strlen($str, $encoding = 'UTF-8', $cleanUtf8 = false)
4388 1
  {
4389
    $str = (string)$str;
4390 1
4391 1
    if (!isset($str[0])) {
4392
      return 0;
4393
    }
4394 1
4395 1 View Code Duplication
    if (
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
4396
        $encoding === 'UTF-8'
4397
        ||
4398
        $encoding === true || $encoding === false // INFO: the "bool"-check is only a fallback for old versions
4399
    ) {
4400
      $encoding = 'UTF-8';
4401
    } else {
4402
      $encoding = self::normalize_encoding($encoding);
4403
    }
4404
4405
    switch ($encoding) {
4406
      case 'ASCII':
4407
      case 'CP850':
4408
        return strlen($str);
4409
    }
4410
4411
    if ($encoding === 'UTF-8' && $cleanUtf8 === true) {
4412
      $str = self::clean($str);
4413
    }
4414
4415
    return \mb_strlen($str, $encoding);
4416
  }
4417 15
4418
  /**
4419 15
   * Case insensitive string comparisons using a "natural order" algorithm.
4420 15
   *
4421
   * INFO: natural order version of UTF8::strcasecmp()
4422 15
   *
4423 2
   * @param string $str1 <p>The first string.</p>
4424
   * @param string $str2 <p>The second string.</p>
4425
   *
4426
   * @return int <strong>&lt; 0</strong> if str1 is less than str2<br />
4427 14
   *             <strong>&gt; 0</strong> if str1 is greater than str2<br />
4428
   *             <strong>0</strong> if they are equal
4429
   */
4430
  public static function strnatcasecmp($str1, $str2)
4431 14
  {
4432
    return self::strnatcmp(self::strtocasefold($str1), self::strtocasefold($str2));
4433
  }
4434
4435 14
  /**
4436
   * String comparisons using a "natural order" algorithm
4437
   *
4438
   * INFO: natural order version of UTF8::strcmp()
4439 1
   *
4440 1
   * @link  http://php.net/manual/en/function.strnatcmp.php
4441 1
   *
4442
   * @param string $str1 <p>The first string.</p>
4443 14
   * @param string $str2 <p>The second string.</p>
4444
   *
4445
   * @return int <strong>&lt; 0</strong> if str1 is less than str2;<br />
4446
   *             <strong>&gt; 0</strong> if str1 is greater than str2;<br />
4447
   *             <strong>0</strong> if they are equal
4448
   */
4449 14
  public static function strnatcmp($str1, $str2)
4450 1
  {
4451 14
    return $str1 . '' === $str2 . '' ? 0 : strnatcmp(self::strtonatfold($str1), self::strtonatfold($str2));
4452 14
  }
4453 14
4454
  /**
4455
   * Case-insensitive string comparison of the first n characters.
4456
   *
4457
   * @link  http://php.net/manual/en/function.strncasecmp.php
4458
   *
4459 14
   * @param string $str1 <p>The first string.</p>
4460 14
   * @param string $str2 <p>The second string.</p>
4461 14
   * @param int    $len  <p>The length of strings to be used in the comparison.</p>
4462 14
   *
4463
   * @return int <strong>&lt; 0</strong> if <i>str1</i> is less than <i>str2</i>;<br />
4464
   *             <strong>&gt; 0</strong> if <i>str1</i> is greater than <i>str2</i>;<br />
4465
   *             <strong>0</strong> if they are equal
4466
   */
4467
  public static function strncasecmp($str1, $str2, $len)
4468
  {
4469
    return self::strncmp(self::strtocasefold($str1), self::strtocasefold($str2), $len);
4470
  }
4471
4472
  /**
4473
   * String comparison of the first n characters.
4474
   *
4475
   * @link  http://php.net/manual/en/function.strncmp.php
4476
   *
4477
   * @param string $str1 <p>The first string.</p>
4478
   * @param string $str2 <p>The second string.</p>
4479
   * @param int    $len  <p>Number of characters to use in the comparison.</p>
4480
   *
4481
   * @return int <strong>&lt; 0</strong> if <i>str1</i> is less than <i>str2</i>;<br />
4482
   *             <strong>&gt; 0</strong> if <i>str1</i> is greater than <i>str2</i>;<br />
4483
   *             <strong>0</strong> if they are equal
4484
   */
4485
  public static function strncmp($str1, $str2, $len)
4486
  {
4487
    $str1 = self::substr($str1, 0, $len);
4488
    $str2 = self::substr($str2, 0, $len);
4489
4490
    return self::strcmp($str1, $str2);
0 ignored issues
show
Security Bug introduced by
It seems like $str1 defined by self::substr($str1, 0, $len) on line 4487 can also be of type false; however, voku\helper\UTF8::strcmp() does only seem to accept string, did you maybe forget to handle an error condition?

This check looks for type mismatches where the missing type is false. This is usually indicative of an error condtion.

Consider the follow example

<?php

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

    return false;
}

This function either returns a new DateTime object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned false before passing on the value to another function or method that may not be able to handle a false.

Loading history...
Security Bug introduced by
It seems like $str2 defined by self::substr($str2, 0, $len) on line 4488 can also be of type false; however, voku\helper\UTF8::strcmp() does only seem to accept string, did you maybe forget to handle an error condition?

This check looks for type mismatches where the missing type is false. This is usually indicative of an error condtion.

Consider the follow example

<?php

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

    return false;
}

This function either returns a new DateTime object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned false before passing on the value to another function or method that may not be able to handle a false.

Loading history...
4491
  }
4492
4493
  /**
4494
   * Search a string for any of a set of characters.
4495
   *
4496
   * @link  http://php.net/manual/en/function.strpbrk.php
4497
   *
4498
   * @param string $haystack  <p>The string where char_list is looked for.</p>
4499
   * @param string $char_list <p>This parameter is case sensitive.</p>
4500
   *
4501
   * @return string String starting from the character found, or false if it is not found.
4502
   */
4503
  public static function strpbrk($haystack, $char_list)
4504
  {
4505
    $haystack = (string)$haystack;
4506
    $char_list = (string)$char_list;
4507 1
4508
    if (!isset($haystack[0], $char_list[0])) {
4509 1
      return false;
4510
    }
4511
4512
    if (preg_match('/' . self::rxClass($char_list) . '/us', $haystack, $m)) {
4513 1
      return substr($haystack, strpos($haystack, $m[0]));
4514
    } else {
4515
      return false;
4516
    }
4517
  }
4518
4519
  /**
4520
   * Find position of first occurrence of string in a string.
4521
   *
4522
   * @link http://php.net/manual/en/function.mb-strpos.php
4523
   *
4524
   * @param string  $haystack  <p>The string being checked.</p>
4525
   * @param string  $needle    <p>The position counted from the beginning of haystack.</p>
4526
   * @param int     $offset    [optional] <p>The search offset. If it is not specified, 0 is used.</p>
4527 1
   * @param string  $encoding  [optional] <p>Set the charset for e.g. "\mb_" function.</p>
4528
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
4529 1
   *
4530
   * @return int|false <p>
4531
   *                   The numeric position of the first occurrence of needle in the haystack string.<br />
4532
   *                   If needle is not found it returns false.
4533
   *                   </p>
4534
   */
4535
  public static function strpos($haystack, $needle, $offset = 0, $encoding = 'UTF-8', $cleanUtf8 = false)
4536
  {
4537
    $haystack = (string)$haystack;
4538
    $needle = (string)$needle;
4539
4540
    if (!isset($haystack[0], $needle[0])) {
4541
      return false;
4542
    }
4543
4544
    // init
4545
    $offset = (int)$offset;
4546
4547
    // iconv and mbstring do not support integer $needle
4548
4549
    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...
4550
      $needle = (string)self::chr($needle);
4551
    }
4552
4553
    if ($cleanUtf8 === true) {
4554
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
4555 4
      // if invalid characters are found in $haystack before $needle
4556
      $needle = self::clean($needle);
4557 4
      $haystack = self::clean($haystack);
4558
    }
4559 4
4560 2
    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
4561
      self::checkForSupport();
4562
    }
4563 3
4564 View Code Duplication
    if (
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
4565
        $encoding === 'UTF-8'
4566
        ||
4567
        $encoding === true || $encoding === false // INFO: the "bool"-check is only a fallback for old versions
4568
    ) {
4569
      $encoding = 'UTF-8';
4570
    } else {
4571
      $encoding = self::normalize_encoding($encoding);
4572
    }
4573
4574
    if (self::$support['mbstring'] === true) {
4575
      return \mb_strpos($haystack, $needle, $offset, $encoding);
4576
    }
4577
4578
    if (self::$support['iconv'] === true) {
4579
      // ignore invalid negative offset to keep compatibility
4580
      // with php < 5.5.35, < 5.6.21, < 7.0.6
0 ignored issues
show
Unused Code Comprehensibility introduced by
39% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
4581
      return \iconv_strpos($haystack, $needle, $offset > 0 ? $offset : 0, $encoding);
4582
    }
4583
4584
    if ($offset > 0) {
4585
      $haystack = self::substr($haystack, $offset);
4586
    }
4587
4588 1 View Code Duplication
    if (($pos = strpos($haystack, $needle)) !== false) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
4589
      $left = substr($haystack, 0, $pos);
4590 1
4591
      // negative offset not supported in PHP strpos(), ignoring
4592
      return ($offset > 0 ? $offset : 0) + self::strlen($left);
4593
    }
4594 1
4595
    return false;
4596
  }
4597
4598
  /**
4599
   * Finds the last occurrence of a character in a string within another.
4600
   *
4601
   * @link http://php.net/manual/en/function.mb-strrchr.php
4602
   *
4603
   * @param string $haystack      <p>The string from which to get the last occurrence of needle.</p>
4604
   * @param string $needle        <p>The string to find in haystack</p>
4605
   * @param bool   $before_needle [optional] <p>
4606
   *                              Determines which portion of haystack
4607
   *                              this function returns.
4608
   *                              If set to true, it returns all of haystack
4609
   *                              from the beginning to the last occurrence of needle.
4610 1
   *                              If set to false, it returns all of haystack
4611
   *                              from the last occurrence of needle to the end,
4612 1
   *                              </p>
4613
   * @param string $encoding      [optional] <p>
4614
   *                              Character encoding name to use.
4615
   *                              If it is omitted, internal character encoding is used.
4616
   *                              </p>
4617
   *
4618
   * @return string|false The portion of haystack or false if needle is not found.
4619
   */
4620 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...
4621
  {
4622
    if ($encoding !== 'UTF-8') {
4623
      $encoding = self::normalize_encoding($encoding);
4624
    }
4625
4626
    if ($cleanUtf8 === true) {
4627
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
4628
      // if invalid characters are found in $haystack before $needle
4629
      $needle = self::clean($needle);
4630
      $haystack = self::clean($haystack);
4631 11
    }
4632
4633 11
    return \mb_strrchr($haystack, $needle, $before_needle, $encoding);
4634
  }
4635 11
4636 2
  /**
4637 2
   * Reverses characters order in the string.
4638
   *
4639 11
   * @param string $str The input string
4640
   *
4641 11
   * @return string The string with characters in the reverse sequence
4642 2
   */
4643
  public static function strrev($str)
4644
  {
4645
    $str = (string)$str;
4646 10
4647 10
    if (!isset($str[0])) {
4648
      return '';
4649 10
    }
4650
4651
    return implode(array_reverse(self::split($str)));
4652 2
  }
4653 2
4654 2
  /**
4655
   * Finds the last occurrence of a character in a string within another, case insensitive.
4656
   *
4657 10
   * @link http://php.net/manual/en/function.mb-strrichr.php
4658
   *
4659
   * @param string  $haystack      <p>The string from which to get the last occurrence of needle.</p>
4660
   * @param string  $needle        <p>The string to find in haystack.</p>
4661 10
   * @param bool    $before_needle [optional] <p>
4662 10
   *                               Determines which portion of haystack
4663
   *                               this function returns.
4664
   *                               If set to true, it returns all of haystack
4665
   *                               from the beginning to the last occurrence of needle.
4666
   *                               If set to false, it returns all of haystack
4667
   *                               from the last occurrence of needle to the end,
4668
   *                               </p>
4669
   * @param string  $encoding      [optional] <p>
4670
   *                               Character encoding name to use.
4671
   *                               If it is omitted, internal character encoding is used.
4672
   *                               </p>
4673
   * @param boolean $cleanUtf8     [optional] <p>Clean non UTF-8 chars from the string.</p>
4674
   *
4675
   * @return string|false <p>The portion of haystack or<br />false if needle is not found.</p>
4676
   */
4677 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...
4678
  {
4679
    if ($encoding !== 'UTF-8') {
4680
      $encoding = self::normalize_encoding($encoding);
4681
    }
4682
4683
    if ($cleanUtf8 === true) {
4684
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
4685
      // if invalid characters are found in $haystack before $needle
4686
      $needle = self::clean($needle);
4687
      $haystack = self::clean($haystack);
4688
    }
4689
4690
    return \mb_strrichr($haystack, $needle, $before_needle, $encoding);
4691
  }
4692
4693
  /**
4694
   * Find position of last occurrence of a case-insensitive string.
4695
   *
4696
   * @param string  $haystack  <p>The string to look in.</p>
4697
   * @param string  $needle    <p>The string to look for.</p>
4698 8
   * @param int     $offset    [optional] <p>Number of characters to ignore in the beginning or end.</p>
4699
   * @param string  $encoding  [optional] <p>Set the charset for e.g. "\mb_" function.</p>
4700 8
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
4701 2
   *
4702 2
   * @return int|false <p>
4703
   *                   The numeric position of the last occurrence of needle in the haystack string.<br />If needle is
4704 8
   *                   not found, it returns false.
4705
   *                   </p>
4706
   */
4707
  public static function strripos($haystack, $needle, $offset = 0, $encoding = 'UTF-8', $cleanUtf8 = false)
4708
  {
4709
    return self::strrpos(self::strtolower($haystack), self::strtolower($needle), $offset, $encoding, $cleanUtf8);
4710
  }
4711
4712
  /**
4713
   * Find position of last occurrence of a string in a string.
4714
   *
4715
   * @link http://php.net/manual/en/function.mb-strrpos.php
4716
   *
4717
   * @param string     $haystack  <p>The string being checked, for the last occurrence of needle</p>
4718
   * @param string|int $needle    <p>The string to find in haystack.<br />Or a code point as int.</p>
4719
   * @param int        $offset    [optional] <p>May be specified to begin searching an arbitrary number of characters
4720 2
   *                              into the string. Negative values will stop searching at an arbitrary point prior to
4721
   *                              the end of the string.
4722 2
   *                              </p>
4723
   * @param string     $encoding  [optional] <p>Set the charset for e.g. "\mb_" function.</p>
4724
   * @param boolean    $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
4725
   *
4726
   * @return int|false <p>The numeric position of the last occurrence of needle in the haystack string.<br />If needle
4727
   *                   is not found, it returns false.</p>
4728 2
   */
4729 2
  public static function strrpos($haystack, $needle, $offset = null, $encoding = 'UTF-8', $cleanUtf8 = false)
4730 2
  {
4731 2
    $haystack = (string)$haystack;
4732
4733
    if (((int)$needle) === $needle && ($needle >= 0)) {
4734
      $needle = self::chr($needle);
4735
    }
4736
4737
    $needle = (string)$needle;
4738
4739
    if (!isset($haystack[0], $needle[0])) {
4740
      return false;
4741
    }
4742
4743
    // init
4744
    $needle = (string)$needle;
4745
    $offset = (int)$offset;
4746
4747
    if ($cleanUtf8 === true) {
4748
      // \mb_strrpos && iconv_strrpos is not tolerant to invalid characters
4749
4750 11
      $needle = self::clean($needle);
4751
      $haystack = self::clean($haystack);
4752 11
    }
4753 11
4754 11
    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
4755
      self::checkForSupport();
4756 11
    }
4757 1
4758 1 View Code Duplication
    if (
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
4759 1
        $encoding === 'UTF-8'
4760
        ||
4761 11
        $encoding === true || $encoding === false // INFO: the "bool"-check is only a fallback for old versions
4762
    ) {
4763 11
      $encoding = 'UTF-8';
4764
    } else {
4765 11
      $encoding = self::normalize_encoding($encoding);
4766 1
    }
4767 1
4768
    if (
4769
        $encoding !== 'UTF-8' // INFO: use "mb_"-function (with polyfill) also if we need another encoding
4770 11
        ||
4771 11
        self::$support['mbstring'] === true
4772
    ) {
4773 11
      return \mb_strrpos($haystack, $needle, $offset, $encoding);
4774
    }
4775 11
4776
    if (self::$support['iconv'] === true) {
4777
      return \grapheme_strrpos($haystack, $needle, $offset);
4778
    }
4779
4780
    // fallback
4781
4782
    if ($offset > 0) {
4783
      $haystack = self::substr($haystack, $offset);
4784
    } elseif ($offset < 0) {
4785
      $haystack = self::substr($haystack, 0, $offset);
4786
    }
4787
4788 21 View Code Duplication
    if (($pos = strrpos($haystack, $needle)) !== false) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
4789
      $left = substr($haystack, 0, $pos);
4790
4791 21
      // negative offset not supported in PHP strpos(), ignoring
4792
      return ($offset > 0 ? $offset : 0) + self::strlen($left);
4793 21
    }
4794 6
4795
    return false;
4796
  }
4797 19
4798
  /**
4799
   * Finds the length of the initial segment of a string consisting entirely of characters contained within a given
4800
   * mask.
4801 19
   *
4802
   * @param string $str    <p>The input string.</p>
4803
   * @param string $mask   <p>The mask of chars</p>
4804
   * @param int    $offset [optional]
4805
   * @param int    $length [optional]
4806
   *
4807
   * @return int
4808
   */
4809
  public static function strspn($str, $mask, $offset = 0, $length = 2147483647)
4810
  {
4811 3
    // init
4812
    $length = (int)$length;
4813 3
    $offset = (int)$offset;
4814
4815
    if ($offset || 2147483647 !== $length) {
4816
      $str = self::substr($str, $offset, $length);
4817
    }
4818
4819
    $str = (string)$str;
4820
    if (!isset($str[0], $mask[0])) {
4821
      return 0;
4822
    }
4823
4824
    return preg_match('/^' . self::rxClass($mask) . '+/u', $str, $str) ? self::strlen($str[0]) : 0;
4825
  }
4826 16
4827
  /**
4828 16
   * Returns part of haystack string from the first occurrence of needle to the end of haystack.
4829
   *
4830 16
   * @param string  $haystack      <p>The input string. Must be valid UTF-8.</p>
4831 4
   * @param string  $needle        <p>The string to look for. Must be valid UTF-8.</p>
4832
   * @param bool    $before_needle [optional] <p>
4833
   *                               If <b>TRUE</b>, strstr() returns the part of the
4834 15
   *                               haystack before the first occurrence of the needle (excluding the needle).
4835
   *                               </p>
4836
   * @param string  $encoding      [optional] <p>Set the charset for e.g. "\mb_" function.</p>
4837
   * @param boolean $cleanUtf8     [optional] <p>Clean non UTF-8 chars from the string.</p>
4838 15
   *
4839
   * @return string|false A sub-string,<br />or <strong>false</strong> if needle is not found.
4840
   */
4841
  public static function strstr($haystack, $needle, $before_needle = false, $encoding = 'UTF-8', $cleanUtf8 = false)
4842
  {
4843
    if ($cleanUtf8 === true) {
4844
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
4845
      // if invalid characters are found in $haystack before $needle
4846
      $needle = self::clean($needle);
4847
      $haystack = self::clean($haystack);
4848
    }
4849
4850
    if ($encoding !== 'UTF-8') {
4851
      $encoding = self::normalize_encoding($encoding);
4852
    }
4853
4854
    if (
4855 1
        $encoding !== 'UTF-8' // INFO: use "mb_"-function (with polyfill) also if we need another encoding
4856
        ||
4857 1
        self::$support['mbstring'] === true
4858 1
    ) {
4859 1
      return \mb_strstr($haystack, $needle, $before_needle, $encoding);
4860 1
    }
4861 1
4862
    return \grapheme_strstr($haystack, $needle, $before_needle);
4863 1
  }
4864 1
4865 1
  /**
4866 1
   * Unicode transformation for case-less matching.
4867 1
   *
4868
   * @link http://unicode.org/reports/tr21/tr21-5.html
4869 1
   *
4870 1
   * @param string $str  <p>The input string.</p>
4871
   * @param bool   $full <p>
4872 1
   *                     <b>true</b> === replace full case folding chars + strtolower (default)<br />
4873
   *                     <b>false</b> use only $commonCaseFold +  strtolower
4874
   *                     </p>
4875
   *
4876
   * @return string
4877
   */
4878
  public static function strtocasefold($str, $full = true)
4879
  {
4880
    static $fullCaseFold = null;
4881
    static $commonCaseFoldKeys = null;
4882
    static $commonCaseFoldValues = null;
4883
4884 1
    if ($commonCaseFoldKeys === null) {
4885
      $commonCaseFoldKeys = array_keys(self::$commonCaseFold);
4886 1
      $commonCaseFoldValues = array_values(self::$commonCaseFold);
4887 1
    }
4888 1
4889
    $str = str_replace($commonCaseFoldKeys, $commonCaseFoldValues, $str);
4890 1
4891
    if ($full) {
4892
4893
      if ($fullCaseFold === null) {
4894 1
        $fullCaseFold = self::getData('caseFolding_full');
4895 1
      }
4896
4897 1
      /** @noinspection OffsetOperationsInspection */
4898
      $str = str_replace($fullCaseFold[0], $fullCaseFold[1], $str);
4899
    }
4900
4901
    $str = self::clean($str);
4902
4903
    return self::strtolower($str);
4904
  }
4905
4906
  /**
4907
   * Make a string lowercase.
4908
   *
4909
   * @link http://php.net/manual/en/function.mb-strtolower.php
4910
   *
4911
   * @param string  $str       <p>The string being lowercased.</p>
4912
   * @param string  $encoding  [optional] <p>Set the charset for e.g. "\mb_" function</p>
4913 47
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
4914
   *
4915
   * @return string str with all alphabetic characters converted to lowercase.
4916 47
   */
4917 View Code Duplication
  public static function strtolower($str, $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...
4918 47
  {
4919 11
    // init
4920
    $str = (string)$str;
4921
4922 45
    if (!isset($str[0])) {
4923
      return '';
4924
    }
4925
4926 1
    if ($cleanUtf8 === true) {
4927 1
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
4928
      // if invalid characters are found in $haystack before $needle
4929 45
      $str = self::clean($str);
4930 45
    }
4931 37
4932 37
    if ($encoding !== 'UTF-8') {
4933
      $encoding = self::normalize_encoding($encoding);
4934 45
    }
4935 2
4936
    return \mb_strtolower($str, $encoding);
4937
  }
4938 43
4939 20
  /**
4940 20
   * Generic case sensitive transformation for collation matching.
4941 41
   *
4942
   * @param string $str <p>The input string</p>
4943
   *
4944 43
   * @return string
4945
   */
4946
  private static function strtonatfold($str)
4947
  {
4948
    return preg_replace('/\p{Mn}+/u', '', \Normalizer::normalize($str, \Normalizer::NFD));
4949
  }
4950 43
4951 1
  /**
4952 43
   * Make a string uppercase.
4953 43
   *
4954 43
   * @link http://php.net/manual/en/function.mb-strtoupper.php
4955
   *
4956
   * @param string  $str       <p>The string being uppercased.</p>
4957
   * @param string  $encoding  [optional] <p>Set the charset for e.g. "\mb_" function.</p>
4958
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
4959
   *
4960 43
   * @return string str with all alphabetic characters converted to uppercase.
4961 43
   */
4962 43 View Code Duplication
  public static function strtoupper($str, $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...
4963 43
  {
4964
    $str = (string)$str;
4965
4966
    if (!isset($str[0])) {
4967
      return '';
4968
    }
4969
4970
    if ($cleanUtf8 === true) {
4971
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
4972
      // if invalid characters are found in $haystack before $needle
4973
      $str = self::clean($str);
4974
    }
4975
4976
    if ($encoding !== 'UTF-8') {
4977
      $encoding = self::normalize_encoding($encoding);
4978
    }
4979
4980
    return \mb_strtoupper($str, $encoding);
4981
  }
4982
4983
  /**
4984
   * Translate characters or replace sub-strings.
4985
   *
4986
   * @link  http://php.net/manual/en/function.strtr.php
4987
   *
4988
   * @param string          $str  <p>The string being translated.</p>
4989
   * @param string|string[] $from <p>The string replacing from.</p>
4990
   * @param string|string[] $to   <p>The string being translated to to.</p>
4991
   *
4992
   * @return string <p>
4993 1
   *                This function returns a copy of str, translating all occurrences of each character in from to the
4994
   *                corresponding character in to.
4995 1
   *                </p>
4996 1
   */
4997
  public static function strtr($str, $from, $to = INF)
4998 1
  {
4999
    if (INF !== $to) {
5000
      $from = self::str_split($from);
0 ignored issues
show
Bug introduced by
It seems like $from defined by self::str_split($from) on line 5000 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...
5001
      $to = self::str_split($to);
0 ignored issues
show
Bug introduced by
It seems like $to defined by self::str_split($to) on line 5001 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...
5002
      $countFrom = count($from);
5003
      $countTo = count($to);
5004
5005
      if ($countFrom > $countTo) {
5006
        $from = array_slice($from, 0, $countTo);
5007
      } elseif ($countFrom < $countTo) {
5008
        $to = array_slice($to, 0, $countFrom);
5009
      }
5010
5011
      $from = array_combine($from, $to);
5012
    }
5013
5014
    return strtr($str, $from);
0 ignored issues
show
Bug introduced by
It seems like $from defined by parameter $from on line 4997 can also be of type string; however, strtr() does only seem to accept array, maybe add an additional type check?

This check looks at variables that have been passed in as parameters and 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...
5015
  }
5016
5017
  /**
5018 1
   * Return the width of a string.
5019
   *
5020 1
   * @param string  $str       <p>The input string.</p>
5021 1
   * @param string  $encoding  [optional] <p>Default is UTF-8</p>
5022
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
5023 1
   *
5024 1
   * @return int
5025
   */
5026
  public static function strwidth($str, $encoding = 'UTF-8', $cleanUtf8 = false)
5027 1
  {
5028 1
    if ($encoding !== 'UTF-8') {
5029 1
      $encoding = self::normalize_encoding($encoding);
5030
    }
5031 1
5032 1
    if ($cleanUtf8 === true) {
5033
      // iconv and mbstring are not tolerant to invalid encoding
5034
      // further, their behaviour is inconsistent with that of PHP's substr
5035 1
5036 1
      $str = self::clean($str);
5037
    }
5038 1
5039
    return \mb_strwidth($str, $encoding);
5040
  }
5041
5042 1
  /**
5043
   * Get part of a string.
5044
   *
5045
   * @link http://php.net/manual/en/function.mb-substr.php
5046
   *
5047
   * @param string  $str       <p>The string being checked.</p>
5048
   * @param int     $start     <p>The first position used in str.</p>
5049
   * @param int     $length    [optional] <p>The maximum length of the returned string.</p>
5050
   * @param string  $encoding  [optional] <p>Default is UTF-8</p>
5051
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
5052
   *
5053
   * @return string Returns a sub-string specified by the start and length parameters.
5054
   */
5055
  public static function substr($str, $start = 0, $length = null, $encoding = 'UTF-8', $cleanUtf8 = false)
5056
  {
5057 6
    // init
5058
    $str = (string)$str;
5059 6
5060 1
    if (!isset($str[0])) {
5061
      return '';
5062
    }
5063 1
5064 1
    if ($cleanUtf8 === true) {
5065 1
      // iconv and mbstring are not tolerant to invalid encoding
5066 1
      // further, their behaviour is inconsistent with that of PHP's substr
5067
5068
      $str = self::clean($str);
5069
    }
5070 1
5071 1
    $str_length = 0;
5072 1
    if ($start || $length === null) {
5073 1
      $str_length = (int)self::strlen($str);
5074 1
    }
5075 1
5076 1
    if ($start && $start > $str_length) {
5077 1
      return false;
5078
    }
5079
5080
    if ($length === null) {
5081 1
      $length = $str_length;
5082 1
    } else {
5083 1
      $length = (int)$length;
5084 1
    }
5085 1
5086 1
    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
5087 1
      self::checkForSupport();
5088 1
    }
5089
5090 View Code Duplication
    if (
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
5091 1
        $encoding === 'UTF-8'
5092 1
        ||
5093 1
        $encoding === true || $encoding === false // INFO: the "bool"-check is only a fallback for old versions
5094 1
    ) {
5095
      $encoding = 'UTF-8';
5096
    } else {
5097
      $encoding = self::normalize_encoding($encoding);
5098 1
    }
5099
5100 6
    if (self::$support['mbstring'] === true) {
5101 1
      return \mb_substr($str, $start, $length, $encoding);
5102 1
    }
5103 1
5104 1
    if (self::$support['iconv'] === true) {
5105
      return \iconv_substr($str, $start, $length, $encoding);
5106 1
    }
5107
5108
    // fallback
5109 6
5110 6
    // split to array, and remove invalid characters
5111
    $array = self::split($str);
5112 6
5113 4
    // extract relevant part, and join to make sting again
5114 4
    return implode(array_slice($array, $start, $length));
5115
  }
5116 6
5117
  /**
5118 6
   * Binary safe comparison of two strings from an offset, up to length characters.
5119
   *
5120
   * @param string  $main_str           <p>The main string being compared.</p>
5121
   * @param string  $str                <p>The secondary string being compared.</p>
5122
   * @param int     $offset             <p>The start position for the comparison. If negative, it starts counting from
5123
   *                                    the end of the string.</p>
5124
   * @param int     $length             [optional] <p>The length of the comparison. The default value is the largest of
5125
   *                                    the length of the str compared to the length of main_str less the offset.</p>
5126
   * @param boolean $case_insensitivity [optional] <p>If case_insensitivity is TRUE, comparison is case
5127
   *                                    insensitive.</p>
5128
   *
5129 1
   * @return int
5130
   */
5131 1
  public static function substr_compare($main_str, $str, $offset, $length = 2147483647, $case_insensitivity = false)
5132
  {
5133 1
    $main_str = self::substr($main_str, $offset, $length);
5134 1
    $str = self::substr($str, 0, self::strlen($main_str));
0 ignored issues
show
Security Bug introduced by
It seems like $main_str defined by self::substr($main_str, $offset, $length) on line 5133 can also be of type false; however, voku\helper\UTF8::strlen() does only seem to accept string, did you maybe forget to handle an error condition?

This check looks for type mismatches where the missing type is false. This is usually indicative of an error condtion.

Consider the follow example

<?php

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

    return false;
}

This function either returns a new DateTime object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned false before passing on the value to another function or method that may not be able to handle a false.

Loading history...
5135
5136
    return $case_insensitivity === true ? self::strcasecmp($main_str, $str) : self::strcmp($main_str, $str);
0 ignored issues
show
Security Bug introduced by
It seems like $main_str defined by self::substr($main_str, $offset, $length) on line 5133 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?

This check looks for type mismatches where the missing type is false. This is usually indicative of an error condtion.

Consider the follow example

<?php

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

    return false;
}

This function either returns a new DateTime object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned false before passing on the value to another function or method that may not be able to handle a false.

Loading history...
Security Bug introduced by
It seems like $str defined by self::substr($str, 0, self::strlen($main_str)) on line 5134 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?

This check looks for type mismatches where the missing type is false. This is usually indicative of an error condtion.

Consider the follow example

<?php

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

    return false;
}

This function either returns a new DateTime object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned false before passing on the value to another function or method that may not be able to handle a false.

Loading history...
Security Bug introduced by
It seems like $main_str defined by self::substr($main_str, $offset, $length) on line 5133 can also be of type false; however, voku\helper\UTF8::strcmp() does only seem to accept string, did you maybe forget to handle an error condition?

This check looks for type mismatches where the missing type is false. This is usually indicative of an error condtion.

Consider the follow example

<?php

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

    return false;
}

This function either returns a new DateTime object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned false before passing on the value to another function or method that may not be able to handle a false.

Loading history...
Security Bug introduced by
It seems like $str defined by self::substr($str, 0, self::strlen($main_str)) on line 5134 can also be of type false; however, voku\helper\UTF8::strcmp() does only seem to accept string, did you maybe forget to handle an error condition?

This check looks for type mismatches where the missing type is false. This is usually indicative of an error condtion.

Consider the follow example

<?php

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

    return false;
}

This function either returns a new DateTime object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned false before passing on the value to another function or method that may not be able to handle a false.

Loading history...
5137 1
  }
5138
5139
  /**
5140
   * Count the number of substring occurrences.
5141 1
   *
5142
   * @link  http://php.net/manual/en/function.substr-count.php
5143 1
   *
5144 1
   * @param string  $haystack  <p>The string to search in.</p>
5145
   * @param string  $needle    <p>The substring to search for.</p>
5146 1
   * @param int     $offset    [optional] <p>The offset where to start counting.</p>
5147
   * @param int     $length    [optional] <p>
5148 1
   *                           The maximum length after the specified offset to search for the
5149 1
   *                           substring. It outputs a warning if the offset plus the length is
5150
   *                           greater than the haystack length.
5151 1
   *                           </p>
5152
   * @param string  $encoding  <p>Set the charset for e.g. "\mb_" function.</p>
5153 1
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
5154
   *
5155 1
   * @return int|false <p>This functions returns an integer or false if there isn't a string.</p>
5156
   */
5157 1
  public static function substr_count($haystack, $needle, $offset = 0, $length = null, $encoding = 'UTF-8', $cleanUtf8 = false)
5158
  {
5159
    $haystack = (string)$haystack;
5160
    $needle = (string)$needle;
5161
5162
    if (!isset($haystack[0], $needle[0])) {
5163
      return false;
5164
    }
5165
5166
    if ($offset || $length) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $length of type integer|null is loosely compared to true; this is ambiguous if the integer can be zero. You might want to explicitly use !== null instead.

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

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

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
5167
      $offset = (int)$offset;
5168
      $length = (int)$length;
5169
5170 6
      if ($length + $offset <= 0) {
5171
        return false;
5172 6
      }
5173
5174
      $haystack = self::substr($haystack, $offset, $length, $encoding);
5175
    }
5176
5177
    if ($encoding !== 'UTF-8') {
5178
      $encoding = self::normalize_encoding($encoding);
5179
    }
5180
5181
    if ($cleanUtf8 === true) {
5182
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
5183
      // if invalid characters are found in $haystack before $needle
5184 1
      $needle = self::clean($needle);
5185
      $haystack = self::clean($haystack);
0 ignored issues
show
Security Bug introduced by
It seems like $haystack can also be of type false; however, voku\helper\UTF8::clean() does only seem to accept string, did you maybe forget to handle an error condition?
Loading history...
5186 1
    }
5187
5188
    return \mb_substr_count($haystack, $needle, $encoding);
5189
  }
5190
5191
  /**
5192
   * Replace text within a portion of a string.
5193
   *
5194
   * source: https://gist.github.com/stemar/8287074
5195
   *
5196
   * @param string|string[] $str         <p>The input string or an array of stings.</p>
5197
   * @param string|string[] $replacement <p>The replacement string or an array of stings.</p>
5198 1
   * @param int|int[]       $start
5199
   * @param int|int[]|void  $length      [optional]
5200 1
   *
5201
   * @return string|string[]
5202
   */
5203
  public static function substr_replace($str, $replacement, $start, $length = null)
5204
  {
5205
    if (is_array($str)) {
5206
      $num = count($str);
5207
5208
      // $replacement
5209
      if (is_array($replacement)) {
5210
        $replacement = array_slice($replacement, 0, $num);
5211 13
      } else {
5212
        $replacement = array_pad(array($replacement), $num, $replacement);
5213 13
      }
5214
5215
      // $start
5216 13 View Code Duplication
      if (is_array($start)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
5217
        $start = array_slice($start, 0, $num);
5218 13
        foreach ($start as &$valueTmp) {
5219 3
          $valueTmp = (int)$valueTmp === $valueTmp ? $valueTmp : 0;
5220
        }
5221
        unset($valueTmp);
5222 11
      } else {
5223
        $start = array_pad(array($start), $num, $start);
5224 11
      }
5225
5226
      // $length
5227
      if (!isset($length)) {
5228 11
        $length = array_fill(0, $num, 0);
5229 11 View Code Duplication
      } elseif (is_array($length)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
5230
        $length = array_slice($length, 0, $num);
5231
        foreach ($length as &$valueTmpV2) {
5232 11
          if (isset($valueTmpV2)) {
5233 11
            $valueTmpV2 = (int)$valueTmpV2 === $valueTmpV2 ? $valueTmpV2 : $num;
5234
          } else {
5235 1
            $valueTmpV2 = 0;
5236
          }
5237 1
        }
5238 1
        unset($valueTmpV2);
5239 1
      } else {
5240
        $length = array_pad(array($length), $num, $length);
5241 1
      }
5242
5243 1
      // Recursive call
5244 1
      return array_map(array(__CLASS__, 'substr_replace'), $str, $replacement, $start, $length);
5245
    } else {
5246
      if (is_array($replacement)) {
5247 1
        if (count($replacement) > 0) {
5248
          $replacement = $replacement[0];
5249
        } else {
5250 1
          $replacement = '';
5251 1
        }
5252 1
      }
5253
    }
5254 1
5255 1
    preg_match_all('/./us', (string)$str, $smatches);
5256
    preg_match_all('/./us', (string)$replacement, $rmatches);
5257 1
5258 1
    if ($length === null) {
5259 1
      $length = \mb_strlen($str);
5260
    }
5261 1
5262 1
    array_splice($smatches[0], $start, $length, $rmatches[0]);
5263
5264 1
    return implode($smatches[0], null);
5265 1
  }
5266 1
5267
  /**
5268 1
   * Returns a case swapped version of the string.
5269
   *
5270
   * @param string  $str       <p>The input string.</p>
5271
   * @param string  $encoding  [optional] <p>Default is UTF-8</p>
5272
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
5273
   *
5274
   * @return string <p>Each character's case swapped.</p>
5275
   */
5276
  public static function swapCase($str, $encoding = 'UTF-8', $cleanUtf8 = false)
5277
  {
5278
    $str = (string)$str;
5279
5280
    if (!isset($str[0])) {
5281
      return '';
5282
    }
5283 1
5284 1
    if ($encoding !== 'UTF-8') {
5285
      $encoding = self::normalize_encoding($encoding);
5286 1
    }
5287
5288
    if ($cleanUtf8 === true) {
5289
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
5290
      // if invalid characters are found in $haystack before $needle
5291 1
      $str = self::clean($str);
5292
    }
5293
5294
    $strSwappedCase = preg_replace_callback(
5295
        '/[\S]/u',
5296 1
        function ($match) use ($encoding) {
5297 1
          $marchToUpper = UTF8::strtoupper($match[0], $encoding);
5298 1
5299 1
          if ($match[0] === $marchToUpper) {
5300
            return UTF8::strtolower($match[0], $encoding);
5301 1
          } else {
5302 1
            return $marchToUpper;
5303 1
          }
5304
        },
5305 1
        $str
5306
    );
5307 1
5308 1
    return $strSwappedCase;
5309 1
  }
5310 1
5311 1
  /**
5312
   * alias for "UTF8::to_ascii()"
5313 1
   *
5314
   * @see UTF8::to_ascii()
5315 1
   *
5316
   * @param string $s
5317
   * @param string $subst_chr
5318
   * @param bool   $strict
5319
   *
5320
   * @return string
5321
   */
5322
  public static function toAscii($s, $subst_chr = '?', $strict = false)
5323
  {
5324
    return self::to_ascii($s, $subst_chr, $strict);
5325
  }
5326
5327 1
  /**
5328
   * alias for "UTF8::to_iso8859()"
5329 1
   *
5330
   * @see UTF8::to_iso8859()
5331
   *
5332
   * @param string $str
5333
   *
5334
   * @return string|string[]
5335
   */
5336
  public static function toIso8859($str)
5337
  {
5338
    return self::to_iso8859($str);
5339
  }
5340
5341 1
  /**
5342
   * alias for "UTF8::to_latin1()"
5343 1
   *
5344
   * @see UTF8::to_latin1()
5345
   *
5346
   * @param $str
5347
   *
5348
   * @return string
5349
   */
5350
  public static function toLatin1($str)
5351
  {
5352
    return self::to_latin1($str);
5353
  }
5354
5355
  /**
5356
   * alias for "UTF8::to_utf8()"
5357
   *
5358
   * @see UTF8::to_utf8()
5359
   *
5360
   * @param string $str
5361
   *
5362
   * @return string
5363
   */
5364
  public static function toUTF8($str)
5365
  {
5366
    return self::to_utf8($str);
5367
  }
5368
5369 20
  /**
5370
   * Convert a string into ASCII.
5371 20
   *
5372 2
   * @param string $str     <p>The input string.</p>
5373
   * @param string $unknown [optional] <p>Character use if character unknown. (default is ?)</p>
5374
   * @param bool   $strict  [optional] <p>Use "transliterator_transliterate()" from PHP-Intl | WARNING: bad
5375 2
   *                        performance</p>
5376 2
   *
5377
   * @return string
5378 2
   *
5379
   * @throws \Exception
5380
   */
5381 20
  public static function to_ascii($str, $unknown = '?', $strict = false)
5382
  {
5383 20
    static $UTF8_TO_ASCII;
5384 4
5385
    // init
5386
    $str = (string)$str;
5387 19
5388 19
    if (!isset($str[0])) {
5389
      return '';
5390
    }
5391 19
5392 19
    $str = self::clean($str, false, true, true);
5393
5394 19
    // check if we only have ASCII
5395 19
    if (self::is_ascii($str) === true) {
5396 19
      return $str;
5397 19
    }
5398
5399 19
    if ($strict === true) {
5400
      if (!isset(self::$support['already_checked_via_portable_utf8'])) {
5401 16
        self::checkForSupport();
5402 16
      }
5403 16
5404 16
      if (self::$support['intl'] == true && Bootup::is_php('5.4')) {
5405 5
        $str = transliterator_transliterate('Any-Latin; Latin-ASCII;', $str);
5406 5
5407 5
        // check again, if we only have ASCII, now ...
5408
        if (self::is_ascii($str) === true) {
5409
          return $str;
5410 19
        }
5411
5412 17
      } else {
5413 13
        throw new \Exception('Intl is not supported or you use PHP < 5.4!');
5414 13
      }
5415 13
    }
5416 8
5417 8
    preg_match_all('/.{1}|[^\x00]{1,1}$/us', $str, $ar);
5418 8
    $chars = $ar[0];
5419
    foreach ($chars as &$c) {
5420
5421 19
      $ordC0 = ord($c[0]);
5422
5423 9
      if ($ordC0 >= 0 && $ordC0 <= 127) {
5424 4
        continue;
5425 4
      }
5426 4
5427 6
      $ordC1 = ord($c[1]);
5428 6
5429 6
      // ASCII - next please
5430
      if ($ordC0 >= 192 && $ordC0 <= 223) {
5431
        $ord = ($ordC0 - 192) * 64 + ($ordC1 - 128);
5432 9
      }
5433 6
5434 6
      if ($ordC0 >= 224) {
5435 6
        $ordC2 = ord($c[2]);
5436
5437
        if ($ordC0 <= 239) {
5438 19
          $ord = ($ordC0 - 224) * 4096 + ($ordC1 - 128) * 64 + ($ordC2 - 128);
5439
        }
5440 4
5441 4
        if ($ordC0 >= 240) {
5442 2
          $ordC3 = ord($c[3]);
5443 2
5444 3
          if ($ordC0 <= 247) {
5445 3
            $ord = ($ordC0 - 240) * 262144 + ($ordC1 - 128) * 4096 + ($ordC2 - 128) * 64 + ($ordC3 - 128);
5446 3
          }
5447
5448
          if ($ordC0 >= 248) {
5449 4
            $ordC4 = ord($c[4]);
5450 16
5451 View Code Duplication
            if ($ordC0 <= 251) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
5452 19
              $ord = ($ordC0 - 248) * 16777216 + ($ordC1 - 128) * 262144 + ($ordC2 - 128) * 4096 + ($ordC3 - 128) * 64 + ($ordC4 - 128);
5453
            }
5454
5455 19
            if ($ordC0 >= 252) {
5456 19
              $ordC5 = ord($c[5]);
5457
5458 3 View Code Duplication
              if ($ordC0 <= 253) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
5459 19
                $ord = ($ordC0 - 252) * 1073741824 + ($ordC1 - 128) * 16777216 + ($ordC2 - 128) * 262144 + ($ordC3 - 128) * 4096 + ($ordC4 - 128) * 64 + ($ordC5 - 128);
5460
              }
5461 19
            }
5462
          }
5463
        }
5464 19
      }
5465 19
5466 19
      if ($ordC0 >= 254 && $ordC0 <= 255) {
5467 2
        $c = $unknown;
5468 19
        continue;
5469
      }
5470 19
5471
      if (!isset($ord)) {
5472 19
        $c = $unknown;
5473
        continue;
5474
      }
5475
5476
      $bank = $ord >> 8;
5477
      if (!array_key_exists($bank, (array)$UTF8_TO_ASCII)) {
5478
        $bankfile = __DIR__ . '/data/' . sprintf('x%02x', $bank) . '.php';
5479
        if (file_exists($bankfile)) {
5480
          /** @noinspection PhpIncludeInspection */
5481
          require $bankfile;
5482 2
        } else {
5483
          $UTF8_TO_ASCII[$bank] = array();
5484 2
        }
5485
      }
5486 1
5487
      $newchar = $ord & 255;
5488
      if (array_key_exists($newchar, $UTF8_TO_ASCII[$bank])) {
5489 1
        $c = $UTF8_TO_ASCII[$bank][$newchar];
5490 1
      } else {
5491
        $c = $unknown;
5492 1
      }
5493
    }
5494
5495 2
    return implode('', $chars);
5496
  }
5497 2
5498 1
  /**
5499
   * Convert a string into "ISO-8859"-encoding (Latin-1).
5500
   *
5501 2
   * @param string|string[] $str
5502
   *
5503
   * @return string|string[]
5504
   */
5505
  public static function to_iso8859($str)
5506
  {
5507
    if (is_array($str)) {
5508
5509
      foreach ($str as $k => $v) {
5510
        /** @noinspection AlterInForeachInspection */
5511
        /** @noinspection OffsetOperationsInspection */
5512
        $str[$k] = self::to_iso8859($v);
5513
      }
5514
5515
      return $str;
5516
    }
5517 26
5518
    $str = (string)$str;
5519 26
5520
    if (!isset($str[0])) {
5521 26
      return '';
5522 5
    }
5523
5524
    return self::utf8_decode($str);
5525
  }
5526 22
5527 6
  /**
5528
   * alias for "UTF8::to_iso8859()"
5529
   *
5530 16
   * @see UTF8::to_iso8859()
5531
   *
5532
   * @param string|string[] $str
5533
   *
5534
   * @return string|string[]
5535
   */
5536
  public static function to_latin1($str)
5537
  {
5538
    return self::to_iso8859($str);
5539
  }
5540 14
5541
  /**
5542 14
   * This function leaves UTF8 characters alone, while converting almost all non-UTF8 to UTF8.
5543
   *
5544
   * - It decode UTF-8 codepoints and unicode escape sequences.
5545
   *
5546
   * - It assumes that the encoding of the original string is either WINDOWS-1252 or ISO-8859-1.
5547
   *
5548
   * - It may fail to convert characters to UTF-8 if they fall into one of these scenarios:
5549
   *
5550
   * 1) when any of these characters:   ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖרÙÚÛÜÝÞß
5551
   *    are followed by any of these:  ("group B")
5552
   *                                    ¡¢£¤¥¦§¨©ª«¬­®¯°±²³´µ¶•¸¹º»¼½¾¿
5553
   * For example:   %ABREPRESENT%C9%BB. «REPRESENTÉ»
5554 1
   * The "«" (%AB) character will be converted, but the "É" followed by "»" (%C9%BB)
5555
   * is also a valid unicode character, and will be left unchanged.
5556 1
   *
5557
   * 2) when any of these: àáâãäåæçèéêëìíîï  are followed by TWO chars from group B,
5558
   * 3) when any of these: ðñòó  are followed by THREE chars from group B.
5559
   *
5560
   * @param string|string[] $str <p>Any string or array.</p>
5561
   *
5562
   * @return string|string[] <p>The UTF-8 encoded string.</p>
5563
   */
5564
  public static function to_utf8($str)
5565
  {
5566
    if (is_array($str)) {
5567 8
      foreach ($str as $k => $v) {
5568
        /** @noinspection AlterInForeachInspection */
5569 8
        /** @noinspection OffsetOperationsInspection */
5570 2
        $str[$k] = self::to_utf8($v);
5571
      }
5572
5573
      return $str;
5574 7
    }
5575 7
5576
    $str = (string)$str;
5577 7
5578 1
    if (!isset($str[0])) {
5579 1
      return $str;
5580 7
    }
5581
5582
    $max = strlen($str);
5583 7
    $buf = '';
5584
5585 7
    /** @noinspection ForeachInvariantsInspection */
5586
    for ($i = 0; $i < $max; $i++) {
5587
      $c1 = $str[$i];
5588
5589 1
      if ($c1 >= "\xc0") { // should be converted to UTF8, if it's not UTF8 already
5590 1
        $c2 = $i + 1 >= $max ? "\x00" : $str[$i + 1];
5591 1
        $c3 = $i + 2 >= $max ? "\x00" : $str[$i + 2];
5592 7
        $c4 = $i + 3 >= $max ? "\x00" : $str[$i + 3];
5593 7
5594 7
        if ($c1 >= "\xc0" & $c1 <= "\xdf") { // looks like 2 bytes UTF8
5595 7
5596 7
          if ($c2 >= "\x80" && $c2 <= "\xbf") { // yeah, almost sure it's UTF8 already
5597
            $buf .= $c1 . $c2;
5598 7
            $i++;
5599
          } else { // not valid UTF8 - convert it
5600
            $cc1 = (chr(ord($c1) / 64) | "\xc0");
5601
            $cc2 = ($c1 & "\x3f") | "\x80";
5602
            $buf .= $cc1 . $cc2;
5603
          }
5604
5605 View Code Duplication
        } elseif ($c1 >= "\xe0" & $c1 <= "\xef") { // looks like 3 bytes UTF8
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
5606
5607
          if ($c2 >= "\x80" && $c2 <= "\xbf" && $c3 >= "\x80" && $c3 <= "\xbf") { // yeah, almost sure it's UTF8 already
5608
            $buf .= $c1 . $c2 . $c3;
5609
            $i += 2;
5610
          } else { // not valid UTF8 - convert it
5611
            $cc1 = (chr(ord($c1) / 64) | "\xc0");
5612
            $cc2 = ($c1 & "\x3f") | "\x80";
5613
            $buf .= $cc1 . $cc2;
5614
          }
5615
5616
        } elseif ($c1 >= "\xf0" & $c1 <= "\xf7") { // looks like 4 bytes UTF8
5617
5618 1 View Code Duplication
          if ($c2 >= "\x80" && $c2 <= "\xbf" && $c3 >= "\x80" && $c3 <= "\xbf" && $c4 >= "\x80" && $c4 <= "\xbf") { // yeah, almost sure it's UTF8 already
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
5619
            $buf .= $c1 . $c2 . $c3 . $c4;
5620 1
            $i += 3;
5621
          } else { // not valid UTF8 - convert it
5622 1
            $cc1 = (chr(ord($c1) / 64) | "\xc0");
5623 1
            $cc2 = ($c1 & "\x3f") | "\x80";
5624
            $buf .= $cc1 . $cc2;
5625
          }
5626 1
5627
        } else { // doesn't look like UTF8, but should be converted
5628 1
          $cc1 = (chr(ord($c1) / 64) | "\xc0");
5629
          $cc2 = (($c1 & "\x3f") | "\x80");
5630 1
          $buf .= $cc1 . $cc2;
5631 1
        }
5632 1
5633 1
      } elseif (($c1 & "\xc0") === "\x80") { // needs conversion
5634
5635 1
        $ordC1 = ord($c1);
5636 1
        if (isset(self::$win1252ToUtf8[$ordC1])) { // found in Windows-1252 special cases
5637 1
          $buf .= self::$win1252ToUtf8[$ordC1];
5638
        } else {
5639 1
          $cc1 = (chr($ordC1 / 64) | "\xc0");
5640
          $cc2 = (($c1 & "\x3f") | "\x80");
5641
          $buf .= $cc1 . $cc2;
5642
        }
5643
5644
      } else { // it doesn't need conversion
5645
        $buf .= $c1;
5646
      }
5647 1
    }
5648
5649
    // decode unicode escape sequences
5650
    $buf = preg_replace_callback(
5651
        '/\\\\u([0-9a-f]{4})/i',
5652
        function ($match) {
5653
          return \mb_convert_encoding(pack('H*', $match[1]), 'UTF-8', 'UCS-2BE');
5654
        },
5655
        $buf
5656
    );
5657
5658
    // decode UTF-8 codepoints
5659
    $buf = preg_replace_callback(
5660
        '/&#\d{2,4};/',
5661
        function ($match) {
5662
          return \mb_convert_encoding($match[0], 'UTF-8', 'HTML-ENTITIES');
5663
        },
5664
        $buf
5665
    );
5666
5667
    return $buf;
5668
  }
5669
5670
  /**
5671
   * Strip whitespace or other characters from beginning or end of a UTF-8 string.
5672
   *
5673
   * INFO: This is slower then "trim()"
5674
   *
5675
   * We can only use the original-function, if we use <= 7-Bit in the string / chars
5676
   * but the check for ACSII (7-Bit) cost more time, then we can safe here.
5677
   *
5678
   * @param string $str   <p>The string to be trimmed</p>
5679
   * @param string $chars [optional] <p>Optional characters to be stripped</p>
5680
   *
5681
   * @return string <p>The trimmed string.</p>
5682
   */
5683
  public static function trim($str = '', $chars = INF)
5684
  {
5685
    $str = (string)$str;
5686
5687
    if (!isset($str[0])) {
5688
      return '';
5689
    }
5690
5691
    // Info: http://nadeausoftware.com/articles/2007/9/php_tip_how_strip_punctuation_characters_web_page#Unicodecharactercategories
5692
    if ($chars === INF || !$chars) {
5693
      return preg_replace('/^[\pZ\pC]+|[\pZ\pC]+$/u', '', $str);
5694
    }
5695
5696
    return self::rtrim(self::ltrim($str, $chars), $chars);
5697
  }
5698
5699
  /**
5700
   * Makes string's first char uppercase.
5701
   *
5702
   * @param string  $str       <p>The input string.</p>
5703
   * @param string  $encoding  [optional] <p>Set the charset for e.g. "\mb_" function.</p>
5704
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
5705
   *
5706
   * @return string <p>The resulting string</p>
5707
   */
5708
  public static function ucfirst($str, $encoding = 'UTF-8', $cleanUtf8 = false)
5709
  {
5710
    return self::strtoupper(self::substr($str, 0, 1, $encoding, $cleanUtf8), $encoding, $cleanUtf8) . self::substr($str, 1, null, $encoding, $cleanUtf8);
0 ignored issues
show
Security Bug introduced by
It seems like self::substr($str, 0, 1, $encoding, $cleanUtf8) targeting voku\helper\UTF8::substr() can also be of type false; however, voku\helper\UTF8::strtoupper() does only seem to accept string, did you maybe forget to handle an error condition?
Loading history...
5711
  }
5712
5713
  /**
5714
   * alias for "UTF8::ucfirst()"
5715
   *
5716
   * @see UTF8::ucfirst()
5717
   *
5718
   * @param string  $word
5719
   * @param string  $encoding
5720
   * @param boolean $cleanUtf8
5721
   *
5722
   * @return string
5723
   */
5724
  public static function ucword($word, $encoding = 'UTF-8', $cleanUtf8 = false)
5725
  {
5726
    return self::ucfirst($word, $encoding, $cleanUtf8);
5727
  }
5728
5729
  /**
5730
   * Uppercase for all words in the string.
5731
   *
5732
   * @param string   $str        <p>The input string.</p>
5733
   * @param string[] $exceptions [optional] <p>Exclusion for some words.</p>
5734
   * @param string   $charlist   [optional] <p>Additional chars that contains to words and do not start a new word.</p>
5735
   * @param string   $encoding   [optional] <p>Set the charset for e.g. "\mb_" function.</p>
5736
   * @param boolean  $cleanUtf8  [optional] <p>Clean non UTF-8 chars from the string.</p>
5737
   *
5738
   * @return string
5739
   */
5740
  public static function ucwords($str, $exceptions = array(), $charlist = '', $encoding = 'UTF-8', $cleanUtf8 = false)
5741
  {
5742
    if (!$str) {
5743
      return '';
5744
    }
5745
5746
    $charlist = self::rxClass($charlist, '\pL');
5747
    $words = \preg_split("/({$charlist}+(?:[\p{Pd}’']{$charlist}+)*)/u", $str, -1, PREG_SPLIT_DELIM_CAPTURE);
5748
    $newwords = array();
5749
5750
    if (count($exceptions) > 0) {
5751
      $useExceptions = true;
5752
    } else {
5753
      $useExceptions = false;
5754
    }
5755
5756
    foreach ($words as $word) {
5757
5758
      if (!$word) {
5759
        continue;
5760
      }
5761
5762
      if (
5763
          ($useExceptions === false)
5764
          ||
5765
          (
5766
              $useExceptions === true
5767
              &&
5768
              !in_array($word, $exceptions, true)
5769
          )
5770
      ) {
5771
        $word = self::ucfirst($word, $encoding, $cleanUtf8);
5772
      }
5773
5774
      $newwords[] = $word;
5775
    }
5776
5777
    return implode('', $newwords);
5778
  }
5779
5780
  /**
5781
   * Multi decode html entity & fix urlencoded-win1252-chars.
5782
   *
5783
   * e.g:
5784
   * 'D&#252;sseldorf'               => 'Düsseldorf'
5785
   * 'D%FCsseldorf'                  => 'Düsseldorf'
5786
   * 'D&#xFC;sseldorf'               => 'Düsseldorf'
5787
   * 'D%26%23xFC%3Bsseldorf'         => 'Düsseldorf'
5788
   * 'Düsseldorf'                   => 'Düsseldorf'
5789
   * 'D%C3%BCsseldorf'               => 'Düsseldorf'
5790
   * 'D%C3%83%C2%BCsseldorf'         => 'Düsseldorf'
5791
   * 'D%25C3%2583%25C2%25BCsseldorf' => 'Düsseldorf'
5792
   *
5793
   * @param string $str <p>The input string.</p>
5794
   *
5795
   * @return string
5796
   */
5797
  public static function urldecode($str)
5798
  {
5799
    $str = (string)$str;
5800
5801
    if (!isset($str[0])) {
5802
      return '';
5803
    }
5804
5805
    $str = preg_replace('/%u([0-9a-f]{3,4})/i', '&#x\\1;', urldecode($str));
5806
5807
    $flags = Bootup::is_php('5.4') ? ENT_QUOTES | ENT_HTML5 : ENT_QUOTES;
5808
5809
    $str = self::fix_simple_utf8(
5810
        rawurldecode(
5811
            self::html_entity_decode(
5812
                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...
5813
                $flags
5814
            )
5815
        )
5816
    );
5817
5818
    return (string)$str;
5819
  }
5820
5821
  /**
5822
   * Return a array with "urlencoded"-win1252 -> UTF-8
5823
   *
5824
   * @return mixed
5825
   */
5826
  public static function urldecode_fix_win1252_chars()
5827
  {
5828
    static $array = array(
5829
        '%20' => ' ',
5830
        '%21' => '!',
5831
        '%22' => '"',
5832
        '%23' => '#',
5833
        '%24' => '$',
5834
        '%25' => '%',
5835
        '%26' => '&',
5836
        '%27' => "'",
5837
        '%28' => '(',
5838
        '%29' => ')',
5839
        '%2A' => '*',
5840
        '%2B' => '+',
5841
        '%2C' => ',',
5842
        '%2D' => '-',
5843
        '%2E' => '.',
5844
        '%2F' => '/',
5845
        '%30' => '0',
5846
        '%31' => '1',
5847
        '%32' => '2',
5848
        '%33' => '3',
5849
        '%34' => '4',
5850
        '%35' => '5',
5851
        '%36' => '6',
5852
        '%37' => '7',
5853
        '%38' => '8',
5854
        '%39' => '9',
5855
        '%3A' => ':',
5856
        '%3B' => ';',
5857
        '%3C' => '<',
5858
        '%3D' => '=',
5859
        '%3E' => '>',
5860
        '%3F' => '?',
5861
        '%40' => '@',
5862
        '%41' => 'A',
5863
        '%42' => 'B',
5864
        '%43' => 'C',
5865
        '%44' => 'D',
5866
        '%45' => 'E',
5867
        '%46' => 'F',
5868
        '%47' => 'G',
5869
        '%48' => 'H',
5870
        '%49' => 'I',
5871
        '%4A' => 'J',
5872
        '%4B' => 'K',
5873
        '%4C' => 'L',
5874 1
        '%4D' => 'M',
5875
        '%4E' => 'N',
5876 1
        '%4F' => 'O',
5877
        '%50' => 'P',
5878
        '%51' => 'Q',
5879
        '%52' => 'R',
5880
        '%53' => 'S',
5881
        '%54' => 'T',
5882
        '%55' => 'U',
5883
        '%56' => 'V',
5884
        '%57' => 'W',
5885
        '%58' => 'X',
5886 6
        '%59' => 'Y',
5887
        '%5A' => 'Z',
5888 6
        '%5B' => '[',
5889 6
        '%5C' => '\\',
5890
        '%5D' => ']',
5891 6
        '%5E' => '^',
5892
        '%5F' => '_',
5893 6
        '%60' => '`',
5894 3
        '%61' => 'a',
5895
        '%62' => 'b',
5896
        '%63' => 'c',
5897
        '%64' => 'd',
5898 6
        '%65' => 'e',
5899
        '%66' => 'f',
5900 6
        '%67' => 'g',
5901 1
        '%68' => 'h',
5902 1
        '%69' => 'i',
5903 1
        '%6A' => 'j',
5904
        '%6B' => 'k',
5905 6
        '%6C' => 'l',
5906
        '%6D' => 'm',
5907
        '%6E' => 'n',
5908
        '%6F' => 'o',
5909
        '%70' => 'p',
5910
        '%71' => 'q',
5911
        '%72' => 'r',
5912
        '%73' => 's',
5913
        '%74' => 't',
5914
        '%75' => 'u',
5915 6
        '%76' => 'v',
5916
        '%77' => 'w',
5917 6
        '%78' => 'x',
5918
        '%79' => 'y',
5919 6
        '%7A' => 'z',
5920 6
        '%7B' => '{',
5921
        '%7C' => '|',
5922
        '%7D' => '}',
5923 5
        '%7E' => '~',
5924 5
        '%7F' => '',
5925
        '%80' => '`',
5926 5
        '%81' => '',
5927 1
        '%82' => '‚',
5928 1
        '%83' => 'ƒ',
5929 1
        '%84' => '„',
5930
        '%85' => '…',
5931 5
        '%86' => '†',
5932
        '%87' => '‡',
5933
        '%88' => 'ˆ',
5934
        '%89' => '‰',
5935
        '%8A' => 'Š',
5936
        '%8B' => '‹',
5937
        '%8C' => 'Œ',
5938
        '%8D' => '',
5939
        '%8E' => 'Ž',
5940
        '%8F' => '',
5941
        '%90' => '',
5942
        '%91' => '‘',
5943
        '%92' => '’',
5944
        '%93' => '“',
5945
        '%94' => '”',
5946
        '%95' => '•',
5947
        '%96' => '–',
5948
        '%97' => '—',
5949
        '%98' => '˜',
5950
        '%99' => '™',
5951
        '%9A' => 'š',
5952
        '%9B' => '›',
5953
        '%9C' => 'œ',
5954
        '%9D' => '',
5955
        '%9E' => 'ž',
5956
        '%9F' => 'Ÿ',
5957
        '%A0' => '',
5958
        '%A1' => '¡',
5959
        '%A2' => '¢',
5960
        '%A3' => '£',
5961 1
        '%A4' => '¤',
5962
        '%A5' => '¥',
5963 1
        '%A6' => '¦',
5964
        '%A7' => '§',
5965
        '%A8' => '¨',
5966
        '%A9' => '©',
5967
        '%AA' => 'ª',
5968
        '%AB' => '«',
5969
        '%AC' => '¬',
5970
        '%AD' => '',
5971
        '%AE' => '®',
5972
        '%AF' => '¯',
5973
        '%B0' => '°',
5974
        '%B1' => '±',
5975 1
        '%B2' => '²',
5976
        '%B3' => '³',
5977 1
        '%B4' => '´',
5978
        '%B5' => 'µ',
5979 1
        '%B6' => '¶',
5980 1
        '%B7' => '·',
5981
        '%B8' => '¸',
5982
        '%B9' => '¹',
5983 1
        '%BA' => 'º',
5984
        '%BB' => '»',
5985 1
        '%BC' => '¼',
5986 1
        '%BD' => '½',
5987
        '%BE' => '¾',
5988
        '%BF' => '¿',
5989 1
        '%C0' => 'À',
5990
        '%C1' => 'Á',
5991
        '%C2' => 'Â',
5992 1
        '%C3' => 'Ã',
5993 1
        '%C4' => 'Ä',
5994 1
        '%C5' => 'Å',
5995 1
        '%C6' => 'Æ',
5996 1
        '%C7' => 'Ç',
5997
        '%C8' => 'È',
5998
        '%C9' => 'É',
5999 1
        '%CA' => 'Ê',
6000
        '%CB' => 'Ë',
6001
        '%CC' => 'Ì',
6002
        '%CD' => 'Í',
6003
        '%CE' => 'Î',
6004
        '%CF' => 'Ï',
6005
        '%D0' => 'Ð',
6006
        '%D1' => 'Ñ',
6007
        '%D2' => 'Ò',
6008
        '%D3' => 'Ó',
6009
        '%D4' => 'Ô',
6010
        '%D5' => 'Õ',
6011
        '%D6' => 'Ö',
6012
        '%D7' => '×',
6013
        '%D8' => 'Ø',
6014
        '%D9' => 'Ù',
6015
        '%DA' => 'Ú',
6016
        '%DB' => 'Û',
6017
        '%DC' => 'Ü',
6018 9
        '%DD' => 'Ý',
6019
        '%DE' => 'Þ',
6020 9
        '%DF' => 'ß',
6021 9
        '%E0' => 'à',
6022
        '%E1' => 'á',
6023 9
        '%E2' => 'â',
6024 2
        '%E3' => 'ã',
6025
        '%E4' => 'ä',
6026
        '%E5' => 'å',
6027 8
        '%E6' => 'æ',
6028 8
        '%E7' => 'ç',
6029 8
        '%E8' => 'è',
6030
        '%E9' => 'é',
6031 8
        '%EA' => 'ê',
6032
        '%EB' => 'ë',
6033
        '%EC' => 'ì',
6034
        '%ED' => 'í',
6035 8
        '%EE' => 'î',
6036
        '%EF' => 'ï',
6037 8
        '%F0' => 'ð',
6038
        '%F1' => 'ñ',
6039 8
        '%F2' => 'ò',
6040 1
        '%F3' => 'ó',
6041 1
        '%F4' => 'ô',
6042 1
        '%F5' => 'õ',
6043
        '%F6' => 'ö',
6044 8
        '%F7' => '÷',
6045 8
        '%F8' => 'ø',
6046
        '%F9' => 'ù',
6047 8
        '%FA' => 'ú',
6048 8
        '%FB' => 'û',
6049 8
        '%FC' => 'ü',
6050 8
        '%FD' => 'ý',
6051 8
        '%FE' => 'þ',
6052
        '%FF' => 'ÿ',
6053 8
    );
6054 8
6055 8
    return $array;
6056 8
  }
6057
6058 8
  /**
6059 6
   * Decodes an UTF-8 string to ISO-8859-1.
6060 6
   *
6061 6
   * @param string $str <p>The input string.</p>
6062 6
   *
6063
   * @return string
6064 6
   */
6065 3
  public static function utf8_decode($str)
6066 3
  {
6067
    static $utf8ToWin1252Keys = null;
6068 6
    static $utf8ToWin1252Values = null;
6069 6
6070
    $str = (string)$str;
6071 8
6072
    if (!isset($str[0])) {
6073
      return '';
6074
    }
6075
6076
    // init
6077
    $str = self::to_utf8($str);
6078
6079 1
    if ($utf8ToWin1252Keys === null) {
6080
      $utf8ToWin1252Keys = array_keys(self::$utf8ToWin1252);
6081 1
      $utf8ToWin1252Values = array_values(self::$utf8ToWin1252);
6082
    }
6083
6084
    return Xml::utf8_decode(str_replace($utf8ToWin1252Keys, $utf8ToWin1252Values, $str));
6085
  }
6086
6087
  /**
6088
   * Encodes an ISO-8859-1 string to UTF-8.
6089
   *
6090
   * @param string $str <p>The input string.</p>
6091
   *
6092
   * @return string
6093
   */
6094
  public static function utf8_encode($str)
6095
  {
6096
    $str = \utf8_encode($str);
6097
6098
    if (false === strpos($str, "\xC2")) {
6099
      return $str;
6100
    } else {
6101
6102
      static $cp1252ToUtf8Keys = null;
6103
      static $cp1252ToUtf8Values = null;
6104
6105
      if ($cp1252ToUtf8Keys === null) {
6106
        $cp1252ToUtf8Keys = array_keys(self::$cp1252ToUtf8);
6107
        $cp1252ToUtf8Values = array_values(self::$cp1252ToUtf8);
6108
      }
6109
6110
      return str_replace($cp1252ToUtf8Keys, $cp1252ToUtf8Values, $str);
6111
    }
6112
  }
6113
6114
  /**
6115
   * fix -> utf8-win1252 chars
6116
   *
6117
   * @param string $str <p>The input string.</p>
6118
   *
6119
   * @return string
6120
   *
6121
   * @deprecated use "UTF8::fix_simple_utf8()"
6122
   */
6123
  public static function utf8_fix_win1252_chars($str)
6124
  {
6125
    return self::fix_simple_utf8($str);
6126
  }
6127
6128
  /**
6129
   * Returns an array with all utf8 whitespace characters.
6130
   *
6131
   * @see   : http://www.bogofilter.org/pipermail/bogofilter/2003-March/001889.html
6132
   *
6133
   * @author: Derek E. [email protected]
6134
   *
6135
   * @return array <p>
6136
   *               An array with all known whitespace characters as values and the type of whitespace as keys
6137
   *               as defined in above URL.
6138
   *               </p>
6139
   */
6140
  public static function whitespace_table()
6141
  {
6142
    return self::$whitespaceTable;
6143
  }
6144
6145
  /**
6146
   * Limit the number of words in a string.
6147
   *
6148
   * @param string $str      <p>The input string.</p>
6149
   * @param int    $words    <p>The limit of words as integer.</p>
6150
   * @param string $strAddOn <p>Replacement for the striped string.</p>
6151
   *
6152
   * @return string
6153
   */
6154
  public static function words_limit($str, $words = 100, $strAddOn = '...')
6155
  {
6156
    $str = (string)$str;
6157
6158
    if (!isset($str[0])) {
6159
      return '';
6160
    }
6161
6162
    $words = (int)$words;
6163
6164
    if ($words < 1) {
6165
      return '';
6166
    }
6167
6168
    preg_match('/^\s*+(?:\S++\s*+){1,' . $words . '}/u', $str, $matches);
6169
6170
    if (
6171
        !isset($matches[0])
6172
        ||
6173
        self::strlen($str) === self::strlen($matches[0])
6174
    ) {
6175
      return $str;
6176
    }
6177
6178
    return self::rtrim($matches[0]) . $strAddOn;
6179
  }
6180
6181
  /**
6182
   * Wraps a string to a given number of characters
6183
   *
6184
   * @link  http://php.net/manual/en/function.wordwrap.php
6185
   *
6186
   * @param string $str   <p>The input string.</p>
6187
   * @param int    $width [optional] <p>The column width.</p>
6188
   * @param string $break [optional] <p>The line is broken using the optional break parameter.</p>
6189
   * @param bool   $cut   [optional] <p>
6190
   *                      If the cut is set to true, the string is
6191
   *                      always wrapped at or before the specified width. So if you have
6192
   *                      a word that is larger than the given width, it is broken apart.
6193
   *                      </p>
6194
   *
6195
   * @return string <p>The given string wrapped at the specified column.</p>
6196
   */
6197
  public static function wordwrap($str, $width = 75, $break = "\n", $cut = false)
6198
  {
6199
    $str = (string)$str;
6200
    $break = (string)$break;
6201
6202
    if (!isset($str[0], $break[0])) {
6203
      return '';
6204
    }
6205
6206
    $w = '';
6207
    $strSplit = explode($break, $str);
6208
    $count = count($strSplit);
6209
6210
    $chars = array();
6211
    /** @noinspection ForeachInvariantsInspection */
6212
    for ($i = 0; $i < $count; ++$i) {
6213
6214
      if ($i) {
6215
        $chars[] = $break;
6216
        $w .= '#';
6217
      }
6218
6219
      $c = $strSplit[$i];
6220
      unset($strSplit[$i]);
6221
6222
      foreach (self::split($c) as $c) {
6223
        $chars[] = $c;
6224
        $w .= ' ' === $c ? ' ' : '?';
6225
      }
6226
    }
6227
6228
    $strReturn = '';
6229
    $j = 0;
6230
    $b = $i = -1;
6231
    $w = wordwrap($w, $width, '#', $cut);
6232
6233
    while (false !== $b = self::strpos($w, '#', $b + 1)) {
6234
      for (++$i; $i < $b; ++$i) {
6235
        $strReturn .= $chars[$j];
6236
        unset($chars[$j++]);
6237
      }
6238
6239
      if ($break === $chars[$j] || ' ' === $chars[$j]) {
6240
        unset($chars[$j++]);
6241
      }
6242
6243
      $strReturn .= $break;
6244
    }
6245
6246
    return $strReturn . implode('', $chars);
6247
  }
6248
6249
  /**
6250
   * Returns an array of Unicode White Space characters.
6251
   *
6252
   * @return array <p>An array with numeric code point as key and White Space Character as value.</p>
6253
   */
6254
  public static function ws()
6255
  {
6256
    return self::$whitespace;
6257
  }
6258
6259
}
6260