Completed
Push — master ( d4a867...a9c6aa )
by Lars
25:08 queued 12:24
created

UTF8::html_entity_decode_callback()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 12
Code Lines 6

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 5
CRAP Score 2

Importance

Changes 0
Metric Value
c 0
b 0
f 0
dl 0
loc 12
ccs 5
cts 5
cp 1
rs 9.4285
cc 2
eloc 6
nc 2
nop 1
crap 2
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
class UTF8
14
{
15
  /**
16
   * @var array
17
   */
18
  protected 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
  protected 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
  protected 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
  protected 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
  protected 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
  protected 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
  protected 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
  protected 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
  protected 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
  protected 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
  protected 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 1
      'ISO-2022-JP-3',
791
      'BIG5-2003',
792 1
      'ISO-IR-230',
793 1
      'TDS565',
794
      'ATARI',
795
      'ATARIST',
796
      'RISCOS-LATIN1',
797
  );
798
799
  /**
800
   * @var array
801
   */
802
  private static $support = array();
803 1
804
  /**
805
   * __construct()
806
   */
807 1
  public function __construct()
808
  {
809
    self::checkForSupport();
810
  }
811
812
  /**
813
   * Return the character at the specified position: $str[1] like functionality.
814
   *
815
   * @param    string $str A UTF-8 string.
816
   * @param    int    $pos The position of character to return.
817
   *
818
   * @return   string Single Multi-Byte character.
819
   */
820
  public static function access($str, $pos)
821
  {
822
    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 The input string
831
   *
832
   * @return   string The output string that contains BOM
833 2
   */
834
  public static function add_bom_to_string($str)
835 2
  {
836
    if (self::string_has_bom($str) === false) {
837
      $str = self::bom() . $str;
838
    }
839
840
    return $str;
841
  }
842
843
  /**
844
   * Returns the UTF-8 Byte Order Mark Character.
845
   *
846 1
   * @return string UTF-8 Byte Order Mark
847
   */
848 1
  public static function bom()
849
  {
850
    return "\xEF\xBB\xBF";
851
  }
852
853
  /**
854
   * @alias of UTF8::chr_map()
855
   *
856
   * @param string|array $callback
857
   * @param string       $str
858
   *
859
   * @return array
860
   */
861
  public static function callback($callback, $str)
862
  {
863
    return self::chr_map($callback, $str);
864
  }
865
866
  /**
867
   * Returns an array of all lower and upper case UTF-8 encoded characters.
868
   *
869
   * @return   string An array with lower case chars as keys and upper chars as values.
870
   */
871
  protected static function case_table()
872
  {
873
    static $case = array(
874
875
      // lower => upper
876
      "\xf0\x90\x91\x8f" => "\xf0\x90\x90\xa7",
877
      "\xf0\x90\x91\x8e" => "\xf0\x90\x90\xa6",
878
      "\xf0\x90\x91\x8d" => "\xf0\x90\x90\xa5",
879
      "\xf0\x90\x91\x8c" => "\xf0\x90\x90\xa4",
880
      "\xf0\x90\x91\x8b" => "\xf0\x90\x90\xa3",
881
      "\xf0\x90\x91\x8a" => "\xf0\x90\x90\xa2",
882
      "\xf0\x90\x91\x89" => "\xf0\x90\x90\xa1",
883
      "\xf0\x90\x91\x88" => "\xf0\x90\x90\xa0",
884
      "\xf0\x90\x91\x87" => "\xf0\x90\x90\x9f",
885
      "\xf0\x90\x91\x86" => "\xf0\x90\x90\x9e",
886
      "\xf0\x90\x91\x85" => "\xf0\x90\x90\x9d",
887
      "\xf0\x90\x91\x84" => "\xf0\x90\x90\x9c",
888
      "\xf0\x90\x91\x83" => "\xf0\x90\x90\x9b",
889
      "\xf0\x90\x91\x82" => "\xf0\x90\x90\x9a",
890
      "\xf0\x90\x91\x81" => "\xf0\x90\x90\x99",
891
      "\xf0\x90\x91\x80" => "\xf0\x90\x90\x98",
892
      "\xf0\x90\x90\xbf" => "\xf0\x90\x90\x97",
893
      "\xf0\x90\x90\xbe" => "\xf0\x90\x90\x96",
894
      "\xf0\x90\x90\xbd" => "\xf0\x90\x90\x95",
895
      "\xf0\x90\x90\xbc" => "\xf0\x90\x90\x94",
896
      "\xf0\x90\x90\xbb" => "\xf0\x90\x90\x93",
897
      "\xf0\x90\x90\xba" => "\xf0\x90\x90\x92",
898
      "\xf0\x90\x90\xb9" => "\xf0\x90\x90\x91",
899
      "\xf0\x90\x90\xb8" => "\xf0\x90\x90\x90",
900
      "\xf0\x90\x90\xb7" => "\xf0\x90\x90\x8f",
901
      "\xf0\x90\x90\xb6" => "\xf0\x90\x90\x8e",
902
      "\xf0\x90\x90\xb5" => "\xf0\x90\x90\x8d",
903
      "\xf0\x90\x90\xb4" => "\xf0\x90\x90\x8c",
904
      "\xf0\x90\x90\xb3" => "\xf0\x90\x90\x8b",
905
      "\xf0\x90\x90\xb2" => "\xf0\x90\x90\x8a",
906
      "\xf0\x90\x90\xb1" => "\xf0\x90\x90\x89",
907
      "\xf0\x90\x90\xb0" => "\xf0\x90\x90\x88",
908
      "\xf0\x90\x90\xaf" => "\xf0\x90\x90\x87",
909
      "\xf0\x90\x90\xae" => "\xf0\x90\x90\x86",
910
      "\xf0\x90\x90\xad" => "\xf0\x90\x90\x85",
911
      "\xf0\x90\x90\xac" => "\xf0\x90\x90\x84",
912
      "\xf0\x90\x90\xab" => "\xf0\x90\x90\x83",
913
      "\xf0\x90\x90\xaa" => "\xf0\x90\x90\x82",
914
      "\xf0\x90\x90\xa9" => "\xf0\x90\x90\x81",
915
      "\xf0\x90\x90\xa8" => "\xf0\x90\x90\x80",
916
      "\xef\xbd\x9a"     => "\xef\xbc\xba",
917
      "\xef\xbd\x99"     => "\xef\xbc\xb9",
918
      "\xef\xbd\x98"     => "\xef\xbc\xb8",
919
      "\xef\xbd\x97"     => "\xef\xbc\xb7",
920
      "\xef\xbd\x96"     => "\xef\xbc\xb6",
921
      "\xef\xbd\x95"     => "\xef\xbc\xb5",
922
      "\xef\xbd\x94"     => "\xef\xbc\xb4",
923
      "\xef\xbd\x93"     => "\xef\xbc\xb3",
924
      "\xef\xbd\x92"     => "\xef\xbc\xb2",
925
      "\xef\xbd\x91"     => "\xef\xbc\xb1",
926
      "\xef\xbd\x90"     => "\xef\xbc\xb0",
927
      "\xef\xbd\x8f"     => "\xef\xbc\xaf",
928
      "\xef\xbd\x8e"     => "\xef\xbc\xae",
929
      "\xef\xbd\x8d"     => "\xef\xbc\xad",
930
      "\xef\xbd\x8c"     => "\xef\xbc\xac",
931
      "\xef\xbd\x8b"     => "\xef\xbc\xab",
932
      "\xef\xbd\x8a"     => "\xef\xbc\xaa",
933
      "\xef\xbd\x89"     => "\xef\xbc\xa9",
934
      "\xef\xbd\x88"     => "\xef\xbc\xa8",
935
      "\xef\xbd\x87"     => "\xef\xbc\xa7",
936
      "\xef\xbd\x86"     => "\xef\xbc\xa6",
937
      "\xef\xbd\x85"     => "\xef\xbc\xa5",
938
      "\xef\xbd\x84"     => "\xef\xbc\xa4",
939
      "\xef\xbd\x83"     => "\xef\xbc\xa3",
940
      "\xef\xbd\x82"     => "\xef\xbc\xa2",
941
      "\xef\xbd\x81"     => "\xef\xbc\xa1",
942
      "\xea\x9e\x8c"     => "\xea\x9e\x8b",
943
      "\xea\x9e\x87"     => "\xea\x9e\x86",
944
      "\xea\x9e\x85"     => "\xea\x9e\x84",
945
      "\xea\x9e\x83"     => "\xea\x9e\x82",
946
      "\xea\x9e\x81"     => "\xea\x9e\x80",
947
      "\xea\x9d\xbf"     => "\xea\x9d\xbe",
948
      "\xea\x9d\xbc"     => "\xea\x9d\xbb",
949
      "\xea\x9d\xba"     => "\xea\x9d\xb9",
950
      "\xea\x9d\xaf"     => "\xea\x9d\xae",
951
      "\xea\x9d\xad"     => "\xea\x9d\xac",
952
      "\xea\x9d\xab"     => "\xea\x9d\xaa",
953
      "\xea\x9d\xa9"     => "\xea\x9d\xa8",
954
      "\xea\x9d\xa7"     => "\xea\x9d\xa6",
955
      "\xea\x9d\xa5"     => "\xea\x9d\xa4",
956
      "\xea\x9d\xa3"     => "\xea\x9d\xa2",
957
      "\xea\x9d\xa1"     => "\xea\x9d\xa0",
958
      "\xea\x9d\x9f"     => "\xea\x9d\x9e",
959
      "\xea\x9d\x9d"     => "\xea\x9d\x9c",
960
      "\xea\x9d\x9b"     => "\xea\x9d\x9a",
961
      "\xea\x9d\x99"     => "\xea\x9d\x98",
962
      "\xea\x9d\x97"     => "\xea\x9d\x96",
963
      "\xea\x9d\x95"     => "\xea\x9d\x94",
964
      "\xea\x9d\x93"     => "\xea\x9d\x92",
965
      "\xea\x9d\x91"     => "\xea\x9d\x90",
966
      "\xea\x9d\x8f"     => "\xea\x9d\x8e",
967
      "\xea\x9d\x8d"     => "\xea\x9d\x8c",
968
      "\xea\x9d\x8b"     => "\xea\x9d\x8a",
969
      "\xea\x9d\x89"     => "\xea\x9d\x88",
970
      "\xea\x9d\x87"     => "\xea\x9d\x86",
971
      "\xea\x9d\x85"     => "\xea\x9d\x84",
972
      "\xea\x9d\x83"     => "\xea\x9d\x82",
973
      "\xea\x9d\x81"     => "\xea\x9d\x80",
974
      "\xea\x9c\xbf"     => "\xea\x9c\xbe",
975
      "\xea\x9c\xbd"     => "\xea\x9c\xbc",
976
      "\xea\x9c\xbb"     => "\xea\x9c\xba",
977
      "\xea\x9c\xb9"     => "\xea\x9c\xb8",
978
      "\xea\x9c\xb7"     => "\xea\x9c\xb6",
979
      "\xea\x9c\xb5"     => "\xea\x9c\xb4",
980
      "\xea\x9c\xb3"     => "\xea\x9c\xb2",
981
      "\xea\x9c\xaf"     => "\xea\x9c\xae",
982
      "\xea\x9c\xad"     => "\xea\x9c\xac",
983
      "\xea\x9c\xab"     => "\xea\x9c\xaa",
984
      "\xea\x9c\xa9"     => "\xea\x9c\xa8",
985
      "\xea\x9c\xa7"     => "\xea\x9c\xa6",
986
      "\xea\x9c\xa5"     => "\xea\x9c\xa4",
987
      "\xea\x9c\xa3"     => "\xea\x9c\xa2",
988
      "\xea\x9a\x97"     => "\xea\x9a\x96",
989
      "\xea\x9a\x95"     => "\xea\x9a\x94",
990
      "\xea\x9a\x93"     => "\xea\x9a\x92",
991
      "\xea\x9a\x91"     => "\xea\x9a\x90",
992
      "\xea\x9a\x8f"     => "\xea\x9a\x8e",
993
      "\xea\x9a\x8d"     => "\xea\x9a\x8c",
994
      "\xea\x9a\x8b"     => "\xea\x9a\x8a",
995
      "\xea\x9a\x89"     => "\xea\x9a\x88",
996
      "\xea\x9a\x87"     => "\xea\x9a\x86",
997
      "\xea\x9a\x85"     => "\xea\x9a\x84",
998
      "\xea\x9a\x83"     => "\xea\x9a\x82",
999
      "\xea\x9a\x81"     => "\xea\x9a\x80",
1000
      "\xea\x99\xad"     => "\xea\x99\xac",
1001
      "\xea\x99\xab"     => "\xea\x99\xaa",
1002
      "\xea\x99\xa9"     => "\xea\x99\xa8",
1003
      "\xea\x99\xa7"     => "\xea\x99\xa6",
1004
      "\xea\x99\xa5"     => "\xea\x99\xa4",
1005
      "\xea\x99\xa3"     => "\xea\x99\xa2",
1006
      "\xea\x99\x9f"     => "\xea\x99\x9e",
1007
      "\xea\x99\x9d"     => "\xea\x99\x9c",
1008
      "\xea\x99\x9b"     => "\xea\x99\x9a",
1009
      "\xea\x99\x99"     => "\xea\x99\x98",
1010
      "\xea\x99\x97"     => "\xea\x99\x96",
1011
      "\xea\x99\x95"     => "\xea\x99\x94",
1012
      "\xea\x99\x93"     => "\xea\x99\x92",
1013
      "\xea\x99\x91"     => "\xea\x99\x90",
1014
      "\xea\x99\x8f"     => "\xea\x99\x8e",
1015
      "\xea\x99\x8d"     => "\xea\x99\x8c",
1016
      "\xea\x99\x8b"     => "\xea\x99\x8a",
1017
      "\xea\x99\x89"     => "\xea\x99\x88",
1018
      "\xea\x99\x87"     => "\xea\x99\x86",
1019
      "\xea\x99\x85"     => "\xea\x99\x84",
1020
      "\xea\x99\x83"     => "\xea\x99\x82",
1021
      "\xea\x99\x81"     => "\xea\x99\x80",
1022
      "\xe2\xb4\xa5"     => "\xe1\x83\x85",
1023
      "\xe2\xb4\xa4"     => "\xe1\x83\x84",
1024
      "\xe2\xb4\xa3"     => "\xe1\x83\x83",
1025
      "\xe2\xb4\xa2"     => "\xe1\x83\x82",
1026
      "\xe2\xb4\xa1"     => "\xe1\x83\x81",
1027
      "\xe2\xb4\xa0"     => "\xe1\x83\x80",
1028
      "\xe2\xb4\x9f"     => "\xe1\x82\xbf",
1029
      "\xe2\xb4\x9e"     => "\xe1\x82\xbe",
1030
      "\xe2\xb4\x9d"     => "\xe1\x82\xbd",
1031
      "\xe2\xb4\x9c"     => "\xe1\x82\xbc",
1032
      "\xe2\xb4\x9b"     => "\xe1\x82\xbb",
1033
      "\xe2\xb4\x9a"     => "\xe1\x82\xba",
1034
      "\xe2\xb4\x99"     => "\xe1\x82\xb9",
1035
      "\xe2\xb4\x98"     => "\xe1\x82\xb8",
1036
      "\xe2\xb4\x97"     => "\xe1\x82\xb7",
1037
      "\xe2\xb4\x96"     => "\xe1\x82\xb6",
1038
      "\xe2\xb4\x95"     => "\xe1\x82\xb5",
1039
      "\xe2\xb4\x94"     => "\xe1\x82\xb4",
1040
      "\xe2\xb4\x93"     => "\xe1\x82\xb3",
1041
      "\xe2\xb4\x92"     => "\xe1\x82\xb2",
1042
      "\xe2\xb4\x91"     => "\xe1\x82\xb1",
1043
      "\xe2\xb4\x90"     => "\xe1\x82\xb0",
1044
      "\xe2\xb4\x8f"     => "\xe1\x82\xaf",
1045
      "\xe2\xb4\x8e"     => "\xe1\x82\xae",
1046
      "\xe2\xb4\x8d"     => "\xe1\x82\xad",
1047
      "\xe2\xb4\x8c"     => "\xe1\x82\xac",
1048
      "\xe2\xb4\x8b"     => "\xe1\x82\xab",
1049
      "\xe2\xb4\x8a"     => "\xe1\x82\xaa",
1050
      "\xe2\xb4\x89"     => "\xe1\x82\xa9",
1051
      "\xe2\xb4\x88"     => "\xe1\x82\xa8",
1052
      "\xe2\xb4\x87"     => "\xe1\x82\xa7",
1053
      "\xe2\xb4\x86"     => "\xe1\x82\xa6",
1054
      "\xe2\xb4\x85"     => "\xe1\x82\xa5",
1055
      "\xe2\xb4\x84"     => "\xe1\x82\xa4",
1056
      "\xe2\xb4\x83"     => "\xe1\x82\xa3",
1057
      "\xe2\xb4\x82"     => "\xe1\x82\xa2",
1058
      "\xe2\xb4\x81"     => "\xe1\x82\xa1",
1059
      "\xe2\xb4\x80"     => "\xe1\x82\xa0",
1060
      "\xe2\xb3\xae"     => "\xe2\xb3\xad",
1061
      "\xe2\xb3\xac"     => "\xe2\xb3\xab",
1062
      "\xe2\xb3\xa3"     => "\xe2\xb3\xa2",
1063
      "\xe2\xb3\xa1"     => "\xe2\xb3\xa0",
1064
      "\xe2\xb3\x9f"     => "\xe2\xb3\x9e",
1065
      "\xe2\xb3\x9d"     => "\xe2\xb3\x9c",
1066
      "\xe2\xb3\x9b"     => "\xe2\xb3\x9a",
1067
      "\xe2\xb3\x99"     => "\xe2\xb3\x98",
1068
      "\xe2\xb3\x97"     => "\xe2\xb3\x96",
1069
      "\xe2\xb3\x95"     => "\xe2\xb3\x94",
1070
      "\xe2\xb3\x93"     => "\xe2\xb3\x92",
1071
      "\xe2\xb3\x91"     => "\xe2\xb3\x90",
1072
      "\xe2\xb3\x8f"     => "\xe2\xb3\x8e",
1073
      "\xe2\xb3\x8d"     => "\xe2\xb3\x8c",
1074
      "\xe2\xb3\x8b"     => "\xe2\xb3\x8a",
1075
      "\xe2\xb3\x89"     => "\xe2\xb3\x88",
1076
      "\xe2\xb3\x87"     => "\xe2\xb3\x86",
1077
      "\xe2\xb3\x85"     => "\xe2\xb3\x84",
1078
      "\xe2\xb3\x83"     => "\xe2\xb3\x82",
1079
      "\xe2\xb3\x81"     => "\xe2\xb3\x80",
1080
      "\xe2\xb2\xbf"     => "\xe2\xb2\xbe",
1081
      "\xe2\xb2\xbd"     => "\xe2\xb2\xbc",
1082
      "\xe2\xb2\xbb"     => "\xe2\xb2\xba",
1083
      "\xe2\xb2\xb9"     => "\xe2\xb2\xb8",
1084
      "\xe2\xb2\xb7"     => "\xe2\xb2\xb6",
1085
      "\xe2\xb2\xb5"     => "\xe2\xb2\xb4",
1086
      "\xe2\xb2\xb3"     => "\xe2\xb2\xb2",
1087
      "\xe2\xb2\xb1"     => "\xe2\xb2\xb0",
1088
      "\xe2\xb2\xaf"     => "\xe2\xb2\xae",
1089
      "\xe2\xb2\xad"     => "\xe2\xb2\xac",
1090
      "\xe2\xb2\xab"     => "\xe2\xb2\xaa",
1091
      "\xe2\xb2\xa9"     => "\xe2\xb2\xa8",
1092
      "\xe2\xb2\xa7"     => "\xe2\xb2\xa6",
1093
      "\xe2\xb2\xa5"     => "\xe2\xb2\xa4",
1094
      "\xe2\xb2\xa3"     => "\xe2\xb2\xa2",
1095
      "\xe2\xb2\xa1"     => "\xe2\xb2\xa0",
1096
      "\xe2\xb2\x9f"     => "\xe2\xb2\x9e",
1097
      "\xe2\xb2\x9d"     => "\xe2\xb2\x9c",
1098
      "\xe2\xb2\x9b"     => "\xe2\xb2\x9a",
1099
      "\xe2\xb2\x99"     => "\xe2\xb2\x98",
1100
      "\xe2\xb2\x97"     => "\xe2\xb2\x96",
1101
      "\xe2\xb2\x95"     => "\xe2\xb2\x94",
1102
      "\xe2\xb2\x93"     => "\xe2\xb2\x92",
1103
      "\xe2\xb2\x91"     => "\xe2\xb2\x90",
1104
      "\xe2\xb2\x8f"     => "\xe2\xb2\x8e",
1105
      "\xe2\xb2\x8d"     => "\xe2\xb2\x8c",
1106
      "\xe2\xb2\x8b"     => "\xe2\xb2\x8a",
1107
      "\xe2\xb2\x89"     => "\xe2\xb2\x88",
1108
      "\xe2\xb2\x87"     => "\xe2\xb2\x86",
1109
      "\xe2\xb2\x85"     => "\xe2\xb2\x84",
1110
      "\xe2\xb2\x83"     => "\xe2\xb2\x82",
1111
      "\xe2\xb2\x81"     => "\xe2\xb2\x80",
1112
      "\xe2\xb1\xb6"     => "\xe2\xb1\xb5",
1113
      "\xe2\xb1\xb3"     => "\xe2\xb1\xb2",
1114
      "\xe2\xb1\xac"     => "\xe2\xb1\xab",
1115
      "\xe2\xb1\xaa"     => "\xe2\xb1\xa9",
1116
      "\xe2\xb1\xa8"     => "\xe2\xb1\xa7",
1117
      "\xe2\xb1\xa6"     => "\xc8\xbe",
1118
      "\xe2\xb1\xa5"     => "\xc8\xba",
1119
      "\xe2\xb1\xa1"     => "\xe2\xb1\xa0",
1120
      "\xe2\xb1\x9e"     => "\xe2\xb0\xae",
1121
      "\xe2\xb1\x9d"     => "\xe2\xb0\xad",
1122
      "\xe2\xb1\x9c"     => "\xe2\xb0\xac",
1123
      "\xe2\xb1\x9b"     => "\xe2\xb0\xab",
1124
      "\xe2\xb1\x9a"     => "\xe2\xb0\xaa",
1125
      "\xe2\xb1\x99"     => "\xe2\xb0\xa9",
1126
      "\xe2\xb1\x98"     => "\xe2\xb0\xa8",
1127
      "\xe2\xb1\x97"     => "\xe2\xb0\xa7",
1128
      "\xe2\xb1\x96"     => "\xe2\xb0\xa6",
1129
      "\xe2\xb1\x95"     => "\xe2\xb0\xa5",
1130
      "\xe2\xb1\x94"     => "\xe2\xb0\xa4",
1131
      "\xe2\xb1\x93"     => "\xe2\xb0\xa3",
1132
      "\xe2\xb1\x92"     => "\xe2\xb0\xa2",
1133
      "\xe2\xb1\x91"     => "\xe2\xb0\xa1",
1134
      "\xe2\xb1\x90"     => "\xe2\xb0\xa0",
1135
      "\xe2\xb1\x8f"     => "\xe2\xb0\x9f",
1136
      "\xe2\xb1\x8e"     => "\xe2\xb0\x9e",
1137
      "\xe2\xb1\x8d"     => "\xe2\xb0\x9d",
1138
      "\xe2\xb1\x8c"     => "\xe2\xb0\x9c",
1139
      "\xe2\xb1\x8b"     => "\xe2\xb0\x9b",
1140
      "\xe2\xb1\x8a"     => "\xe2\xb0\x9a",
1141
      "\xe2\xb1\x89"     => "\xe2\xb0\x99",
1142
      "\xe2\xb1\x88"     => "\xe2\xb0\x98",
1143
      "\xe2\xb1\x87"     => "\xe2\xb0\x97",
1144
      "\xe2\xb1\x86"     => "\xe2\xb0\x96",
1145
      "\xe2\xb1\x85"     => "\xe2\xb0\x95",
1146
      "\xe2\xb1\x84"     => "\xe2\xb0\x94",
1147
      "\xe2\xb1\x83"     => "\xe2\xb0\x93",
1148
      "\xe2\xb1\x82"     => "\xe2\xb0\x92",
1149
      "\xe2\xb1\x81"     => "\xe2\xb0\x91",
1150
      "\xe2\xb1\x80"     => "\xe2\xb0\x90",
1151
      "\xe2\xb0\xbf"     => "\xe2\xb0\x8f",
1152
      "\xe2\xb0\xbe"     => "\xe2\xb0\x8e",
1153
      "\xe2\xb0\xbd"     => "\xe2\xb0\x8d",
1154
      "\xe2\xb0\xbc"     => "\xe2\xb0\x8c",
1155
      "\xe2\xb0\xbb"     => "\xe2\xb0\x8b",
1156
      "\xe2\xb0\xba"     => "\xe2\xb0\x8a",
1157
      "\xe2\xb0\xb9"     => "\xe2\xb0\x89",
1158
      "\xe2\xb0\xb8"     => "\xe2\xb0\x88",
1159
      "\xe2\xb0\xb7"     => "\xe2\xb0\x87",
1160
      "\xe2\xb0\xb6"     => "\xe2\xb0\x86",
1161
      "\xe2\xb0\xb5"     => "\xe2\xb0\x85",
1162
      "\xe2\xb0\xb4"     => "\xe2\xb0\x84",
1163
      "\xe2\xb0\xb3"     => "\xe2\xb0\x83",
1164
      "\xe2\xb0\xb2"     => "\xe2\xb0\x82",
1165
      "\xe2\xb0\xb1"     => "\xe2\xb0\x81",
1166
      "\xe2\xb0\xb0"     => "\xe2\xb0\x80",
1167
      "\xe2\x86\x84"     => "\xe2\x86\x83",
1168
      "\xe2\x85\x8e"     => "\xe2\x84\xb2",
1169
      "\xe1\xbf\xb3"     => "\xe1\xbf\xbc",
1170
      "\xe1\xbf\xa5"     => "\xe1\xbf\xac",
1171
      "\xe1\xbf\xa1"     => "\xe1\xbf\xa9",
1172
      "\xe1\xbf\xa0"     => "\xe1\xbf\xa8",
1173
      "\xe1\xbf\x91"     => "\xe1\xbf\x99",
1174
      "\xe1\xbf\x90"     => "\xe1\xbf\x98",
1175
      "\xe1\xbf\x83"     => "\xe1\xbf\x8c",
1176
      "\xe1\xbe\xbe"     => "\xce\x99",
1177
      "\xe1\xbe\xb3"     => "\xe1\xbe\xbc",
1178
      "\xe1\xbe\xb1"     => "\xe1\xbe\xb9",
1179
      "\xe1\xbe\xb0"     => "\xe1\xbe\xb8",
1180
      "\xe1\xbe\xa7"     => "\xe1\xbe\xaf",
1181
      "\xe1\xbe\xa6"     => "\xe1\xbe\xae",
1182
      "\xe1\xbe\xa5"     => "\xe1\xbe\xad",
1183
      "\xe1\xbe\xa4"     => "\xe1\xbe\xac",
1184
      "\xe1\xbe\xa3"     => "\xe1\xbe\xab",
1185
      "\xe1\xbe\xa2"     => "\xe1\xbe\xaa",
1186
      "\xe1\xbe\xa1"     => "\xe1\xbe\xa9",
1187
      "\xe1\xbe\xa0"     => "\xe1\xbe\xa8",
1188
      "\xe1\xbe\x97"     => "\xe1\xbe\x9f",
1189
      "\xe1\xbe\x96"     => "\xe1\xbe\x9e",
1190
      "\xe1\xbe\x95"     => "\xe1\xbe\x9d",
1191
      "\xe1\xbe\x94"     => "\xe1\xbe\x9c",
1192
      "\xe1\xbe\x93"     => "\xe1\xbe\x9b",
1193
      "\xe1\xbe\x92"     => "\xe1\xbe\x9a",
1194
      "\xe1\xbe\x91"     => "\xe1\xbe\x99",
1195
      "\xe1\xbe\x90"     => "\xe1\xbe\x98",
1196
      "\xe1\xbe\x87"     => "\xe1\xbe\x8f",
1197
      "\xe1\xbe\x86"     => "\xe1\xbe\x8e",
1198
      "\xe1\xbe\x85"     => "\xe1\xbe\x8d",
1199
      "\xe1\xbe\x84"     => "\xe1\xbe\x8c",
1200
      "\xe1\xbe\x83"     => "\xe1\xbe\x8b",
1201
      "\xe1\xbe\x82"     => "\xe1\xbe\x8a",
1202
      "\xe1\xbe\x81"     => "\xe1\xbe\x89",
1203
      "\xe1\xbe\x80"     => "\xe1\xbe\x88",
1204
      "\xe1\xbd\xbd"     => "\xe1\xbf\xbb",
1205
      "\xe1\xbd\xbc"     => "\xe1\xbf\xba",
1206
      "\xe1\xbd\xbb"     => "\xe1\xbf\xab",
1207
      "\xe1\xbd\xba"     => "\xe1\xbf\xaa",
1208
      "\xe1\xbd\xb9"     => "\xe1\xbf\xb9",
1209
      "\xe1\xbd\xb8"     => "\xe1\xbf\xb8",
1210
      "\xe1\xbd\xb7"     => "\xe1\xbf\x9b",
1211
      "\xe1\xbd\xb6"     => "\xe1\xbf\x9a",
1212
      "\xe1\xbd\xb5"     => "\xe1\xbf\x8b",
1213
      "\xe1\xbd\xb4"     => "\xe1\xbf\x8a",
1214
      "\xe1\xbd\xb3"     => "\xe1\xbf\x89",
1215
      "\xe1\xbd\xb2"     => "\xe1\xbf\x88",
1216
      "\xe1\xbd\xb1"     => "\xe1\xbe\xbb",
1217
      "\xe1\xbd\xb0"     => "\xe1\xbe\xba",
1218
      "\xe1\xbd\xa7"     => "\xe1\xbd\xaf",
1219
      "\xe1\xbd\xa6"     => "\xe1\xbd\xae",
1220
      "\xe1\xbd\xa5"     => "\xe1\xbd\xad",
1221
      "\xe1\xbd\xa4"     => "\xe1\xbd\xac",
1222
      "\xe1\xbd\xa3"     => "\xe1\xbd\xab",
1223
      "\xe1\xbd\xa2"     => "\xe1\xbd\xaa",
1224
      "\xe1\xbd\xa1"     => "\xe1\xbd\xa9",
1225
      "\xe1\xbd\xa0"     => "\xe1\xbd\xa8",
1226
      "\xe1\xbd\x97"     => "\xe1\xbd\x9f",
1227
      "\xe1\xbd\x95"     => "\xe1\xbd\x9d",
1228
      "\xe1\xbd\x93"     => "\xe1\xbd\x9b",
1229
      "\xe1\xbd\x91"     => "\xe1\xbd\x99",
1230
      "\xe1\xbd\x85"     => "\xe1\xbd\x8d",
1231
      "\xe1\xbd\x84"     => "\xe1\xbd\x8c",
1232
      "\xe1\xbd\x83"     => "\xe1\xbd\x8b",
1233
      "\xe1\xbd\x82"     => "\xe1\xbd\x8a",
1234
      "\xe1\xbd\x81"     => "\xe1\xbd\x89",
1235
      "\xe1\xbd\x80"     => "\xe1\xbd\x88",
1236
      "\xe1\xbc\xb7"     => "\xe1\xbc\xbf",
1237
      "\xe1\xbc\xb6"     => "\xe1\xbc\xbe",
1238
      "\xe1\xbc\xb5"     => "\xe1\xbc\xbd",
1239
      "\xe1\xbc\xb4"     => "\xe1\xbc\xbc",
1240
      "\xe1\xbc\xb3"     => "\xe1\xbc\xbb",
1241
      "\xe1\xbc\xb2"     => "\xe1\xbc\xba",
1242
      "\xe1\xbc\xb1"     => "\xe1\xbc\xb9",
1243
      "\xe1\xbc\xb0"     => "\xe1\xbc\xb8",
1244
      "\xe1\xbc\xa7"     => "\xe1\xbc\xaf",
1245
      "\xe1\xbc\xa6"     => "\xe1\xbc\xae",
1246
      "\xe1\xbc\xa5"     => "\xe1\xbc\xad",
1247
      "\xe1\xbc\xa4"     => "\xe1\xbc\xac",
1248
      "\xe1\xbc\xa3"     => "\xe1\xbc\xab",
1249
      "\xe1\xbc\xa2"     => "\xe1\xbc\xaa",
1250
      "\xe1\xbc\xa1"     => "\xe1\xbc\xa9",
1251
      "\xe1\xbc\xa0"     => "\xe1\xbc\xa8",
1252
      "\xe1\xbc\x95"     => "\xe1\xbc\x9d",
1253
      "\xe1\xbc\x94"     => "\xe1\xbc\x9c",
1254
      "\xe1\xbc\x93"     => "\xe1\xbc\x9b",
1255
      "\xe1\xbc\x92"     => "\xe1\xbc\x9a",
1256
      "\xe1\xbc\x91"     => "\xe1\xbc\x99",
1257
      "\xe1\xbc\x90"     => "\xe1\xbc\x98",
1258
      "\xe1\xbc\x87"     => "\xe1\xbc\x8f",
1259
      "\xe1\xbc\x86"     => "\xe1\xbc\x8e",
1260
      "\xe1\xbc\x85"     => "\xe1\xbc\x8d",
1261
      "\xe1\xbc\x84"     => "\xe1\xbc\x8c",
1262
      "\xe1\xbc\x83"     => "\xe1\xbc\x8b",
1263
      "\xe1\xbc\x82"     => "\xe1\xbc\x8a",
1264
      "\xe1\xbc\x81"     => "\xe1\xbc\x89",
1265
      "\xe1\xbc\x80"     => "\xe1\xbc\x88",
1266
      "\xe1\xbb\xbf"     => "\xe1\xbb\xbe",
1267
      "\xe1\xbb\xbd"     => "\xe1\xbb\xbc",
1268
      "\xe1\xbb\xbb"     => "\xe1\xbb\xba",
1269
      "\xe1\xbb\xb9"     => "\xe1\xbb\xb8",
1270
      "\xe1\xbb\xb7"     => "\xe1\xbb\xb6",
1271
      "\xe1\xbb\xb5"     => "\xe1\xbb\xb4",
1272
      "\xe1\xbb\xb3"     => "\xe1\xbb\xb2",
1273
      "\xe1\xbb\xb1"     => "\xe1\xbb\xb0",
1274
      "\xe1\xbb\xaf"     => "\xe1\xbb\xae",
1275
      "\xe1\xbb\xad"     => "\xe1\xbb\xac",
1276
      "\xe1\xbb\xab"     => "\xe1\xbb\xaa",
1277
      "\xe1\xbb\xa9"     => "\xe1\xbb\xa8",
1278
      "\xe1\xbb\xa7"     => "\xe1\xbb\xa6",
1279
      "\xe1\xbb\xa5"     => "\xe1\xbb\xa4",
1280
      "\xe1\xbb\xa3"     => "\xe1\xbb\xa2",
1281
      "\xe1\xbb\xa1"     => "\xe1\xbb\xa0",
1282
      "\xe1\xbb\x9f"     => "\xe1\xbb\x9e",
1283
      "\xe1\xbb\x9d"     => "\xe1\xbb\x9c",
1284
      "\xe1\xbb\x9b"     => "\xe1\xbb\x9a",
1285
      "\xe1\xbb\x99"     => "\xe1\xbb\x98",
1286
      "\xe1\xbb\x97"     => "\xe1\xbb\x96",
1287
      "\xe1\xbb\x95"     => "\xe1\xbb\x94",
1288
      "\xe1\xbb\x93"     => "\xe1\xbb\x92",
1289
      "\xe1\xbb\x91"     => "\xe1\xbb\x90",
1290
      "\xe1\xbb\x8f"     => "\xe1\xbb\x8e",
1291
      "\xe1\xbb\x8d"     => "\xe1\xbb\x8c",
1292
      "\xe1\xbb\x8b"     => "\xe1\xbb\x8a",
1293
      "\xe1\xbb\x89"     => "\xe1\xbb\x88",
1294
      "\xe1\xbb\x87"     => "\xe1\xbb\x86",
1295
      "\xe1\xbb\x85"     => "\xe1\xbb\x84",
1296
      "\xe1\xbb\x83"     => "\xe1\xbb\x82",
1297
      "\xe1\xbb\x81"     => "\xe1\xbb\x80",
1298
      "\xe1\xba\xbf"     => "\xe1\xba\xbe",
1299
      "\xe1\xba\xbd"     => "\xe1\xba\xbc",
1300
      "\xe1\xba\xbb"     => "\xe1\xba\xba",
1301
      "\xe1\xba\xb9"     => "\xe1\xba\xb8",
1302
      "\xe1\xba\xb7"     => "\xe1\xba\xb6",
1303
      "\xe1\xba\xb5"     => "\xe1\xba\xb4",
1304
      "\xe1\xba\xb3"     => "\xe1\xba\xb2",
1305
      "\xe1\xba\xb1"     => "\xe1\xba\xb0",
1306
      "\xe1\xba\xaf"     => "\xe1\xba\xae",
1307
      "\xe1\xba\xad"     => "\xe1\xba\xac",
1308
      "\xe1\xba\xab"     => "\xe1\xba\xaa",
1309
      "\xe1\xba\xa9"     => "\xe1\xba\xa8",
1310
      "\xe1\xba\xa7"     => "\xe1\xba\xa6",
1311
      "\xe1\xba\xa5"     => "\xe1\xba\xa4",
1312
      "\xe1\xba\xa3"     => "\xe1\xba\xa2",
1313
      "\xe1\xba\xa1"     => "\xe1\xba\xa0",
1314
      "\xe1\xba\x9b"     => "\xe1\xb9\xa0",
1315
      "\xe1\xba\x95"     => "\xe1\xba\x94",
1316
      "\xe1\xba\x93"     => "\xe1\xba\x92",
1317
      "\xe1\xba\x91"     => "\xe1\xba\x90",
1318
      "\xe1\xba\x8f"     => "\xe1\xba\x8e",
1319
      "\xe1\xba\x8d"     => "\xe1\xba\x8c",
1320
      "\xe1\xba\x8b"     => "\xe1\xba\x8a",
1321
      "\xe1\xba\x89"     => "\xe1\xba\x88",
1322
      "\xe1\xba\x87"     => "\xe1\xba\x86",
1323
      "\xe1\xba\x85"     => "\xe1\xba\x84",
1324
      "\xe1\xba\x83"     => "\xe1\xba\x82",
1325
      "\xe1\xba\x81"     => "\xe1\xba\x80",
1326
      "\xe1\xb9\xbf"     => "\xe1\xb9\xbe",
1327
      "\xe1\xb9\xbd"     => "\xe1\xb9\xbc",
1328
      "\xe1\xb9\xbb"     => "\xe1\xb9\xba",
1329
      "\xe1\xb9\xb9"     => "\xe1\xb9\xb8",
1330
      "\xe1\xb9\xb7"     => "\xe1\xb9\xb6",
1331
      "\xe1\xb9\xb5"     => "\xe1\xb9\xb4",
1332
      "\xe1\xb9\xb3"     => "\xe1\xb9\xb2",
1333
      "\xe1\xb9\xb1"     => "\xe1\xb9\xb0",
1334
      "\xe1\xb9\xaf"     => "\xe1\xb9\xae",
1335
      "\xe1\xb9\xad"     => "\xe1\xb9\xac",
1336
      "\xe1\xb9\xab"     => "\xe1\xb9\xaa",
1337
      "\xe1\xb9\xa9"     => "\xe1\xb9\xa8",
1338
      "\xe1\xb9\xa7"     => "\xe1\xb9\xa6",
1339
      "\xe1\xb9\xa5"     => "\xe1\xb9\xa4",
1340
      "\xe1\xb9\xa3"     => "\xe1\xb9\xa2",
1341
      "\xe1\xb9\xa1"     => "\xe1\xb9\xa0",
1342
      "\xe1\xb9\x9f"     => "\xe1\xb9\x9e",
1343
      "\xe1\xb9\x9d"     => "\xe1\xb9\x9c",
1344
      "\xe1\xb9\x9b"     => "\xe1\xb9\x9a",
1345
      "\xe1\xb9\x99"     => "\xe1\xb9\x98",
1346
      "\xe1\xb9\x97"     => "\xe1\xb9\x96",
1347
      "\xe1\xb9\x95"     => "\xe1\xb9\x94",
1348
      "\xe1\xb9\x93"     => "\xe1\xb9\x92",
1349
      "\xe1\xb9\x91"     => "\xe1\xb9\x90",
1350
      "\xe1\xb9\x8f"     => "\xe1\xb9\x8e",
1351
      "\xe1\xb9\x8d"     => "\xe1\xb9\x8c",
1352
      "\xe1\xb9\x8b"     => "\xe1\xb9\x8a",
1353
      "\xe1\xb9\x89"     => "\xe1\xb9\x88",
1354
      "\xe1\xb9\x87"     => "\xe1\xb9\x86",
1355
      "\xe1\xb9\x85"     => "\xe1\xb9\x84",
1356
      "\xe1\xb9\x83"     => "\xe1\xb9\x82",
1357
      "\xe1\xb9\x81"     => "\xe1\xb9\x80",
1358
      "\xe1\xb8\xbf"     => "\xe1\xb8\xbe",
1359
      "\xe1\xb8\xbd"     => "\xe1\xb8\xbc",
1360
      "\xe1\xb8\xbb"     => "\xe1\xb8\xba",
1361
      "\xe1\xb8\xb9"     => "\xe1\xb8\xb8",
1362
      "\xe1\xb8\xb7"     => "\xe1\xb8\xb6",
1363
      "\xe1\xb8\xb5"     => "\xe1\xb8\xb4",
1364
      "\xe1\xb8\xb3"     => "\xe1\xb8\xb2",
1365
      "\xe1\xb8\xb1"     => "\xe1\xb8\xb0",
1366
      "\xe1\xb8\xaf"     => "\xe1\xb8\xae",
1367
      "\xe1\xb8\xad"     => "\xe1\xb8\xac",
1368
      "\xe1\xb8\xab"     => "\xe1\xb8\xaa",
1369
      "\xe1\xb8\xa9"     => "\xe1\xb8\xa8",
1370
      "\xe1\xb8\xa7"     => "\xe1\xb8\xa6",
1371
      "\xe1\xb8\xa5"     => "\xe1\xb8\xa4",
1372
      "\xe1\xb8\xa3"     => "\xe1\xb8\xa2",
1373
      "\xe1\xb8\xa1"     => "\xe1\xb8\xa0",
1374
      "\xe1\xb8\x9f"     => "\xe1\xb8\x9e",
1375
      "\xe1\xb8\x9d"     => "\xe1\xb8\x9c",
1376
      "\xe1\xb8\x9b"     => "\xe1\xb8\x9a",
1377
      "\xe1\xb8\x99"     => "\xe1\xb8\x98",
1378
      "\xe1\xb8\x97"     => "\xe1\xb8\x96",
1379
      "\xe1\xb8\x95"     => "\xe1\xb8\x94",
1380
      "\xe1\xb8\x93"     => "\xe1\xb8\x92",
1381
      "\xe1\xb8\x91"     => "\xe1\xb8\x90",
1382
      "\xe1\xb8\x8f"     => "\xe1\xb8\x8e",
1383
      "\xe1\xb8\x8d"     => "\xe1\xb8\x8c",
1384
      "\xe1\xb8\x8b"     => "\xe1\xb8\x8a",
1385
      "\xe1\xb8\x89"     => "\xe1\xb8\x88",
1386
      "\xe1\xb8\x87"     => "\xe1\xb8\x86",
1387
      "\xe1\xb8\x85"     => "\xe1\xb8\x84",
1388
      "\xe1\xb8\x83"     => "\xe1\xb8\x82",
1389
      "\xe1\xb8\x81"     => "\xe1\xb8\x80",
1390
      "\xe1\xb5\xbd"     => "\xe2\xb1\xa3",
1391
      "\xe1\xb5\xb9"     => "\xea\x9d\xbd",
1392
      "\xd6\x86"         => "\xd5\x96",
1393
      "\xd6\x85"         => "\xd5\x95",
1394
      "\xd6\x84"         => "\xd5\x94",
1395
      "\xd6\x83"         => "\xd5\x93",
1396
      "\xd6\x82"         => "\xd5\x92",
1397
      "\xd6\x81"         => "\xd5\x91",
1398
      "\xd6\x80"         => "\xd5\x90",
1399
      "\xd5\xbf"         => "\xd5\x8f",
1400
      "\xd5\xbe"         => "\xd5\x8e",
1401
      "\xd5\xbd"         => "\xd5\x8d",
1402
      "\xd5\xbc"         => "\xd5\x8c",
1403
      "\xd5\xbb"         => "\xd5\x8b",
1404
      "\xd5\xba"         => "\xd5\x8a",
1405
      "\xd5\xb9"         => "\xd5\x89",
1406
      "\xd5\xb8"         => "\xd5\x88",
1407
      "\xd5\xb7"         => "\xd5\x87",
1408
      "\xd5\xb6"         => "\xd5\x86",
1409
      "\xd5\xb5"         => "\xd5\x85",
1410
      "\xd5\xb4"         => "\xd5\x84",
1411
      "\xd5\xb3"         => "\xd5\x83",
1412
      "\xd5\xb2"         => "\xd5\x82",
1413
      "\xd5\xb1"         => "\xd5\x81",
1414
      "\xd5\xb0"         => "\xd5\x80",
1415
      "\xd5\xaf"         => "\xd4\xbf",
1416
      "\xd5\xae"         => "\xd4\xbe",
1417
      "\xd5\xad"         => "\xd4\xbd",
1418
      "\xd5\xac"         => "\xd4\xbc",
1419
      "\xd5\xab"         => "\xd4\xbb",
1420
      "\xd5\xaa"         => "\xd4\xba",
1421
      "\xd5\xa9"         => "\xd4\xb9",
1422
      "\xd5\xa8"         => "\xd4\xb8",
1423
      "\xd5\xa7"         => "\xd4\xb7",
1424
      "\xd5\xa6"         => "\xd4\xb6",
1425
      "\xd5\xa5"         => "\xd4\xb5",
1426
      "\xd5\xa4"         => "\xd4\xb4",
1427
      "\xd5\xa3"         => "\xd4\xb3",
1428
      "\xd5\xa2"         => "\xd4\xb2",
1429
      "\xd5\xa1"         => "\xd4\xb1",
1430
      "\xd4\xa5"         => "\xd4\xa4",
1431
      "\xd4\xa3"         => "\xd4\xa2",
1432
      "\xd4\xa1"         => "\xd4\xa0",
1433
      "\xd4\x9f"         => "\xd4\x9e",
1434
      "\xd4\x9d"         => "\xd4\x9c",
1435
      "\xd4\x9b"         => "\xd4\x9a",
1436
      "\xd4\x99"         => "\xd4\x98",
1437
      "\xd4\x97"         => "\xd4\x96",
1438
      "\xd4\x95"         => "\xd4\x94",
1439
      "\xd4\x93"         => "\xd4\x92",
1440
      "\xd4\x91"         => "\xd4\x90",
1441
      "\xd4\x8f"         => "\xd4\x8e",
1442
      "\xd4\x8d"         => "\xd4\x8c",
1443
      "\xd4\x8b"         => "\xd4\x8a",
1444
      "\xd4\x89"         => "\xd4\x88",
1445
      "\xd4\x87"         => "\xd4\x86",
1446
      "\xd4\x85"         => "\xd4\x84",
1447
      "\xd4\x83"         => "\xd4\x82",
1448
      "\xd4\x81"         => "\xd4\x80",
1449
      "\xd3\xbf"         => "\xd3\xbe",
1450
      "\xd3\xbd"         => "\xd3\xbc",
1451
      "\xd3\xbb"         => "\xd3\xba",
1452
      "\xd3\xb9"         => "\xd3\xb8",
1453
      "\xd3\xb7"         => "\xd3\xb6",
1454
      "\xd3\xb5"         => "\xd3\xb4",
1455
      "\xd3\xb3"         => "\xd3\xb2",
1456
      "\xd3\xb1"         => "\xd3\xb0",
1457
      "\xd3\xaf"         => "\xd3\xae",
1458
      "\xd3\xad"         => "\xd3\xac",
1459
      "\xd3\xab"         => "\xd3\xaa",
1460
      "\xd3\xa9"         => "\xd3\xa8",
1461
      "\xd3\xa7"         => "\xd3\xa6",
1462
      "\xd3\xa5"         => "\xd3\xa4",
1463
      "\xd3\xa3"         => "\xd3\xa2",
1464
      "\xd3\xa1"         => "\xd3\xa0",
1465
      "\xd3\x9f"         => "\xd3\x9e",
1466
      "\xd3\x9d"         => "\xd3\x9c",
1467
      "\xd3\x9b"         => "\xd3\x9a",
1468
      "\xd3\x99"         => "\xd3\x98",
1469
      "\xd3\x97"         => "\xd3\x96",
1470
      "\xd3\x95"         => "\xd3\x94",
1471
      "\xd3\x93"         => "\xd3\x92",
1472
      "\xd3\x91"         => "\xd3\x90",
1473
      "\xd3\x8f"         => "\xd3\x80",
1474
      "\xd3\x8e"         => "\xd3\x8d",
1475
      "\xd3\x8c"         => "\xd3\x8b",
1476
      "\xd3\x8a"         => "\xd3\x89",
1477
      "\xd3\x88"         => "\xd3\x87",
1478
      "\xd3\x86"         => "\xd3\x85",
1479
      "\xd3\x84"         => "\xd3\x83",
1480
      "\xd3\x82"         => "\xd3\x81",
1481
      "\xd2\xbf"         => "\xd2\xbe",
1482
      "\xd2\xbd"         => "\xd2\xbc",
1483
      "\xd2\xbb"         => "\xd2\xba",
1484
      "\xd2\xb9"         => "\xd2\xb8",
1485
      "\xd2\xb7"         => "\xd2\xb6",
1486
      "\xd2\xb5"         => "\xd2\xb4",
1487
      "\xd2\xb3"         => "\xd2\xb2",
1488
      "\xd2\xb1"         => "\xd2\xb0",
1489
      "\xd2\xaf"         => "\xd2\xae",
1490
      "\xd2\xad"         => "\xd2\xac",
1491
      "\xd2\xab"         => "\xd2\xaa",
1492
      "\xd2\xa9"         => "\xd2\xa8",
1493
      "\xd2\xa7"         => "\xd2\xa6",
1494
      "\xd2\xa5"         => "\xd2\xa4",
1495
      "\xd2\xa3"         => "\xd2\xa2",
1496
      "\xd2\xa1"         => "\xd2\xa0",
1497
      "\xd2\x9f"         => "\xd2\x9e",
1498
      "\xd2\x9d"         => "\xd2\x9c",
1499
      "\xd2\x9b"         => "\xd2\x9a",
1500
      "\xd2\x99"         => "\xd2\x98",
1501
      "\xd2\x97"         => "\xd2\x96",
1502
      "\xd2\x95"         => "\xd2\x94",
1503
      "\xd2\x93"         => "\xd2\x92",
1504
      "\xd2\x91"         => "\xd2\x90",
1505
      "\xd2\x8f"         => "\xd2\x8e",
1506
      "\xd2\x8d"         => "\xd2\x8c",
1507
      "\xd2\x8b"         => "\xd2\x8a",
1508
      "\xd2\x81"         => "\xd2\x80",
1509
      "\xd1\xbf"         => "\xd1\xbe",
1510
      "\xd1\xbd"         => "\xd1\xbc",
1511
      "\xd1\xbb"         => "\xd1\xba",
1512
      "\xd1\xb9"         => "\xd1\xb8",
1513
      "\xd1\xb7"         => "\xd1\xb6",
1514
      "\xd1\xb5"         => "\xd1\xb4",
1515
      "\xd1\xb3"         => "\xd1\xb2",
1516
      "\xd1\xb1"         => "\xd1\xb0",
1517
      "\xd1\xaf"         => "\xd1\xae",
1518
      "\xd1\xad"         => "\xd1\xac",
1519
      "\xd1\xab"         => "\xd1\xaa",
1520
      "\xd1\xa9"         => "\xd1\xa8",
1521
      "\xd1\xa7"         => "\xd1\xa6",
1522
      "\xd1\xa5"         => "\xd1\xa4",
1523
      "\xd1\xa3"         => "\xd1\xa2",
1524
      "\xd1\xa1"         => "\xd1\xa0",
1525
      "\xd1\x9f"         => "\xd0\x8f",
1526
      "\xd1\x9e"         => "\xd0\x8e",
1527
      "\xd1\x9d"         => "\xd0\x8d",
1528
      "\xd1\x9c"         => "\xd0\x8c",
1529
      "\xd1\x9b"         => "\xd0\x8b",
1530
      "\xd1\x9a"         => "\xd0\x8a",
1531
      "\xd1\x99"         => "\xd0\x89",
1532
      "\xd1\x98"         => "\xd0\x88",
1533
      "\xd1\x97"         => "\xd0\x87",
1534
      "\xd1\x96"         => "\xd0\x86",
1535
      "\xd1\x95"         => "\xd0\x85",
1536
      "\xd1\x94"         => "\xd0\x84",
1537
      "\xd1\x93"         => "\xd0\x83",
1538
      "\xd1\x92"         => "\xd0\x82",
1539
      "\xd1\x91"         => "\xd0\x81",
1540
      "\xd1\x90"         => "\xd0\x80",
1541
      "\xd1\x8f"         => "\xd0\xaf",
1542
      "\xd1\x8e"         => "\xd0\xae",
1543
      "\xd1\x8d"         => "\xd0\xad",
1544
      "\xd1\x8c"         => "\xd0\xac",
1545
      "\xd1\x8b"         => "\xd0\xab",
1546
      "\xd1\x8a"         => "\xd0\xaa",
1547
      "\xd1\x89"         => "\xd0\xa9",
1548
      "\xd1\x88"         => "\xd0\xa8",
1549
      "\xd1\x87"         => "\xd0\xa7",
1550
      "\xd1\x86"         => "\xd0\xa6",
1551
      "\xd1\x85"         => "\xd0\xa5",
1552
      "\xd1\x84"         => "\xd0\xa4",
1553
      "\xd1\x83"         => "\xd0\xa3",
1554
      "\xd1\x82"         => "\xd0\xa2",
1555
      "\xd1\x81"         => "\xd0\xa1",
1556
      "\xd1\x80"         => "\xd0\xa0",
1557
      "\xd0\xbf"         => "\xd0\x9f",
1558
      "\xd0\xbe"         => "\xd0\x9e",
1559
      "\xd0\xbd"         => "\xd0\x9d",
1560
      "\xd0\xbc"         => "\xd0\x9c",
1561
      "\xd0\xbb"         => "\xd0\x9b",
1562
      "\xd0\xba"         => "\xd0\x9a",
1563
      "\xd0\xb9"         => "\xd0\x99",
1564
      "\xd0\xb8"         => "\xd0\x98",
1565
      "\xd0\xb7"         => "\xd0\x97",
1566
      "\xd0\xb6"         => "\xd0\x96",
1567
      "\xd0\xb5"         => "\xd0\x95",
1568
      "\xd0\xb4"         => "\xd0\x94",
1569
      "\xd0\xb3"         => "\xd0\x93",
1570
      "\xd0\xb2"         => "\xd0\x92",
1571
      "\xd0\xb1"         => "\xd0\x91",
1572
      "\xd0\xb0"         => "\xd0\x90",
1573
      "\xcf\xbb"         => "\xcf\xba",
1574
      "\xcf\xb8"         => "\xcf\xb7",
1575
      "\xcf\xb5"         => "\xce\x95",
1576
      "\xcf\xb2"         => "\xcf\xb9",
1577
      "\xcf\xb1"         => "\xce\xa1",
1578
      "\xcf\xb0"         => "\xce\x9a",
1579
      "\xcf\xaf"         => "\xcf\xae",
1580
      "\xcf\xad"         => "\xcf\xac",
1581
      "\xcf\xab"         => "\xcf\xaa",
1582
      "\xcf\xa9"         => "\xcf\xa8",
1583
      "\xcf\xa7"         => "\xcf\xa6",
1584
      "\xcf\xa5"         => "\xcf\xa4",
1585
      "\xcf\xa3"         => "\xcf\xa2",
1586
      "\xcf\xa1"         => "\xcf\xa0",
1587
      "\xcf\x9f"         => "\xcf\x9e",
1588
      "\xcf\x9d"         => "\xcf\x9c",
1589
      "\xcf\x9b"         => "\xcf\x9a",
1590
      "\xcf\x99"         => "\xcf\x98",
1591
      "\xcf\x97"         => "\xcf\x8f",
1592
      "\xcf\x96"         => "\xce\xa0",
1593
      "\xcf\x95"         => "\xce\xa6",
1594
      "\xcf\x91"         => "\xce\x98",
1595
      "\xcf\x90"         => "\xce\x92",
1596
      "\xcf\x8e"         => "\xce\x8f",
1597
      "\xcf\x8d"         => "\xce\x8e",
1598
      "\xcf\x8c"         => "\xce\x8c",
1599
      "\xcf\x8b"         => "\xce\xab",
1600
      "\xcf\x8a"         => "\xce\xaa",
1601
      "\xcf\x89"         => "\xce\xa9",
1602
      "\xcf\x88"         => "\xce\xa8",
1603
      "\xcf\x87"         => "\xce\xa7",
1604
      "\xcf\x86"         => "\xce\xa6",
1605
      "\xcf\x85"         => "\xce\xa5",
1606
      "\xcf\x84"         => "\xce\xa4",
1607
      "\xcf\x83"         => "\xce\xa3",
1608
      "\xcf\x82"         => "\xce\xa3",
1609
      "\xcf\x81"         => "\xce\xa1",
1610
      "\xcf\x80"         => "\xce\xa0",
1611
      "\xce\xbf"         => "\xce\x9f",
1612
      "\xce\xbe"         => "\xce\x9e",
1613
      "\xce\xbd"         => "\xce\x9d",
1614
      "\xce\xbc"         => "\xce\x9c",
1615
      "\xce\xbb"         => "\xce\x9b",
1616
      "\xce\xba"         => "\xce\x9a",
1617
      "\xce\xb9"         => "\xce\x99",
1618
      "\xce\xb8"         => "\xce\x98",
1619
      "\xce\xb7"         => "\xce\x97",
1620
      "\xce\xb6"         => "\xce\x96",
1621
      "\xce\xb5"         => "\xce\x95",
1622
      "\xce\xb4"         => "\xce\x94",
1623
      "\xce\xb3"         => "\xce\x93",
1624
      "\xce\xb2"         => "\xce\x92",
1625
      "\xce\xb1"         => "\xce\x91",
1626
      "\xce\xaf"         => "\xce\x8a",
1627
      "\xce\xae"         => "\xce\x89",
1628
      "\xce\xad"         => "\xce\x88",
1629
      "\xce\xac"         => "\xce\x86",
1630
      "\xcd\xbd"         => "\xcf\xbf",
1631
      "\xcd\xbc"         => "\xcf\xbe",
1632
      "\xcd\xbb"         => "\xcf\xbd",
1633
      "\xcd\xb7"         => "\xcd\xb6",
1634
      "\xcd\xb3"         => "\xcd\xb2",
1635
      "\xcd\xb1"         => "\xcd\xb0",
1636
      "\xca\x92"         => "\xc6\xb7",
1637
      "\xca\x8c"         => "\xc9\x85",
1638
      "\xca\x8b"         => "\xc6\xb2",
1639
      "\xca\x8a"         => "\xc6\xb1",
1640
      "\xca\x89"         => "\xc9\x84",
1641
      "\xca\x88"         => "\xc6\xae",
1642
      "\xca\x83"         => "\xc6\xa9",
1643
      "\xca\x80"         => "\xc6\xa6",
1644
      "\xc9\xbd"         => "\xe2\xb1\xa4",
1645
      "\xc9\xb5"         => "\xc6\x9f",
1646
      "\xc9\xb2"         => "\xc6\x9d",
1647
      "\xc9\xb1"         => "\xe2\xb1\xae",
1648
      "\xc9\xaf"         => "\xc6\x9c",
1649
      "\xc9\xab"         => "\xe2\xb1\xa2",
1650
      "\xc9\xa9"         => "\xc6\x96",
1651
      "\xc9\xa8"         => "\xc6\x97",
1652
      "\xc9\xa5"         => "\xea\x9e\x8d",
1653
      "\xc9\xa3"         => "\xc6\x94",
1654
      "\xc9\xa0"         => "\xc6\x93",
1655
      "\xc9\x9b"         => "\xc6\x90",
1656
      "\xc9\x99"         => "\xc6\x8f",
1657
      "\xc9\x97"         => "\xc6\x8a",
1658
      "\xc9\x96"         => "\xc6\x89",
1659
      "\xc9\x94"         => "\xc6\x86",
1660
      "\xc9\x93"         => "\xc6\x81",
1661
      "\xc9\x92"         => "\xe2\xb1\xb0",
1662
      "\xc9\x91"         => "\xe2\xb1\xad",
1663
      "\xc9\x90"         => "\xe2\xb1\xaf",
1664
      "\xc9\x8f"         => "\xc9\x8e",
1665
      "\xc9\x8d"         => "\xc9\x8c",
1666
      "\xc9\x8b"         => "\xc9\x8a",
1667
      "\xc9\x89"         => "\xc9\x88",
1668
      "\xc9\x87"         => "\xc9\x86",
1669
      "\xc9\x82"         => "\xc9\x81",
1670
      "\xc9\x80"         => "\xe2\xb1\xbf",
1671
      "\xc8\xbf"         => "\xe2\xb1\xbe",
1672
      "\xc8\xbc"         => "\xc8\xbb",
1673
      "\xc8\xb3"         => "\xc8\xb2",
1674
      "\xc8\xb1"         => "\xc8\xb0",
1675
      "\xc8\xaf"         => "\xc8\xae",
1676
      "\xc8\xad"         => "\xc8\xac",
1677
      "\xc8\xab"         => "\xc8\xaa",
1678
      "\xc8\xa9"         => "\xc8\xa8",
1679
      "\xc8\xa7"         => "\xc8\xa6",
1680
      "\xc8\xa5"         => "\xc8\xa4",
1681
      "\xc8\xa3"         => "\xc8\xa2",
1682
      "\xc8\x9f"         => "\xc8\x9e",
1683
      "\xc8\x9d"         => "\xc8\x9c",
1684
      "\xc8\x9b"         => "\xc8\x9a",
1685
      "\xc8\x99"         => "\xc8\x98",
1686
      "\xc8\x97"         => "\xc8\x96",
1687
      "\xc8\x95"         => "\xc8\x94",
1688
      "\xc8\x93"         => "\xc8\x92",
1689
      "\xc8\x91"         => "\xc8\x90",
1690
      "\xc8\x8f"         => "\xc8\x8e",
1691
      "\xc8\x8d"         => "\xc8\x8c",
1692
      "\xc8\x8b"         => "\xc8\x8a",
1693
      "\xc8\x89"         => "\xc8\x88",
1694
      "\xc8\x87"         => "\xc8\x86",
1695
      "\xc8\x85"         => "\xc8\x84",
1696
      "\xc8\x83"         => "\xc8\x82",
1697
      "\xc8\x81"         => "\xc8\x80",
1698
      "\xc7\xbf"         => "\xc7\xbe",
1699
      "\xc7\xbd"         => "\xc7\xbc",
1700
      "\xc7\xbb"         => "\xc7\xba",
1701
      "\xc7\xb9"         => "\xc7\xb8",
1702
      "\xc7\xb5"         => "\xc7\xb4",
1703
      "\xc7\xb3"         => "\xc7\xb2",
1704
      "\xc7\xaf"         => "\xc7\xae",
1705
      "\xc7\xad"         => "\xc7\xac",
1706
      "\xc7\xab"         => "\xc7\xaa",
1707
      "\xc7\xa9"         => "\xc7\xa8",
1708
      "\xc7\xa7"         => "\xc7\xa6",
1709
      "\xc7\xa5"         => "\xc7\xa4",
1710
      "\xc7\xa3"         => "\xc7\xa2",
1711
      "\xc7\xa1"         => "\xc7\xa0",
1712
      "\xc7\x9f"         => "\xc7\x9e",
1713
      "\xc7\x9d"         => "\xc6\x8e",
1714
      "\xc7\x9c"         => "\xc7\x9b",
1715
      "\xc7\x9a"         => "\xc7\x99",
1716
      "\xc7\x98"         => "\xc7\x97",
1717
      "\xc7\x96"         => "\xc7\x95",
1718
      "\xc7\x94"         => "\xc7\x93",
1719
      "\xc7\x92"         => "\xc7\x91",
1720
      "\xc7\x90"         => "\xc7\x8f",
1721
      "\xc7\x8e"         => "\xc7\x8d",
1722
      "\xc7\x8c"         => "\xc7\x8b",
1723
      "\xc7\x89"         => "\xc7\x88",
1724
      "\xc7\x86"         => "\xc7\x85",
1725
      "\xc6\xbf"         => "\xc7\xb7",
1726
      "\xc6\xbd"         => "\xc6\xbc",
1727
      "\xc6\xb9"         => "\xc6\xb8",
1728
      "\xc6\xb6"         => "\xc6\xb5",
1729
      "\xc6\xb4"         => "\xc6\xb3",
1730
      "\xc6\xb0"         => "\xc6\xaf",
1731
      "\xc6\xad"         => "\xc6\xac",
1732
      "\xc6\xa8"         => "\xc6\xa7",
1733
      "\xc6\xa5"         => "\xc6\xa4",
1734
      "\xc6\xa3"         => "\xc6\xa2",
1735
      "\xc6\xa1"         => "\xc6\xa0",
1736
      "\xc6\x9e"         => "\xc8\xa0",
1737
      "\xc6\x9a"         => "\xc8\xbd",
1738
      "\xc6\x99"         => "\xc6\x98",
1739
      "\xc6\x95"         => "\xc7\xb6",
1740
      "\xc6\x92"         => "\xc6\x91",
1741
      "\xc6\x8c"         => "\xc6\x8b",
1742
      "\xc6\x88"         => "\xc6\x87",
1743
      "\xc6\x85"         => "\xc6\x84",
1744
      "\xc6\x83"         => "\xc6\x82",
1745
      "\xc6\x80"         => "\xc9\x83",
1746
      "\xc5\xbf"         => "\x53",
1747
      "\xc5\xbe"         => "\xc5\xbd",
1748
      "\xc5\xbc"         => "\xc5\xbb",
1749
      "\xc5\xba"         => "\xc5\xb9",
1750
      "\xc5\xb7"         => "\xc5\xb6",
1751
      "\xc5\xb5"         => "\xc5\xb4",
1752
      "\xc5\xb3"         => "\xc5\xb2",
1753
      "\xc5\xb1"         => "\xc5\xb0",
1754
      "\xc5\xaf"         => "\xc5\xae",
1755
      "\xc5\xad"         => "\xc5\xac",
1756
      "\xc5\xab"         => "\xc5\xaa",
1757
      "\xc5\xa9"         => "\xc5\xa8",
1758
      "\xc5\xa7"         => "\xc5\xa6",
1759
      "\xc5\xa5"         => "\xc5\xa4",
1760
      "\xc5\xa3"         => "\xc5\xa2",
1761
      "\xc5\xa1"         => "\xc5\xa0",
1762
      "\xc5\x9f"         => "\xc5\x9e",
1763
      "\xc5\x9d"         => "\xc5\x9c",
1764
      "\xc5\x9b"         => "\xc5\x9a",
1765
      "\xc5\x99"         => "\xc5\x98",
1766
      "\xc5\x97"         => "\xc5\x96",
1767
      "\xc5\x95"         => "\xc5\x94",
1768
      "\xc5\x93"         => "\xc5\x92",
1769
      "\xc5\x91"         => "\xc5\x90",
1770
      "\xc5\x8f"         => "\xc5\x8e",
1771
      "\xc5\x8d"         => "\xc5\x8c",
1772
      "\xc5\x8b"         => "\xc5\x8a",
1773
      "\xc5\x88"         => "\xc5\x87",
1774
      "\xc5\x86"         => "\xc5\x85",
1775
      "\xc5\x84"         => "\xc5\x83",
1776
      "\xc5\x82"         => "\xc5\x81",
1777
      "\xc5\x80"         => "\xc4\xbf",
1778
      "\xc4\xbe"         => "\xc4\xbd",
1779
      "\xc4\xbc"         => "\xc4\xbb",
1780
      "\xc4\xba"         => "\xc4\xb9",
1781
      "\xc4\xb7"         => "\xc4\xb6",
1782
      "\xc4\xb5"         => "\xc4\xb4",
1783
      "\xc4\xb3"         => "\xc4\xb2",
1784
      "\xc4\xb1"         => "\x49",
1785
      "\xc4\xaf"         => "\xc4\xae",
1786
      "\xc4\xad"         => "\xc4\xac",
1787
      "\xc4\xab"         => "\xc4\xaa",
1788
      "\xc4\xa9"         => "\xc4\xa8",
1789
      "\xc4\xa7"         => "\xc4\xa6",
1790
      "\xc4\xa5"         => "\xc4\xa4",
1791
      "\xc4\xa3"         => "\xc4\xa2",
1792
      "\xc4\xa1"         => "\xc4\xa0",
1793
      "\xc4\x9f"         => "\xc4\x9e",
1794
      "\xc4\x9d"         => "\xc4\x9c",
1795
      "\xc4\x9b"         => "\xc4\x9a",
1796
      "\xc4\x99"         => "\xc4\x98",
1797
      "\xc4\x97"         => "\xc4\x96",
1798
      "\xc4\x95"         => "\xc4\x94",
1799
      "\xc4\x93"         => "\xc4\x92",
1800
      "\xc4\x91"         => "\xc4\x90",
1801
      "\xc4\x8f"         => "\xc4\x8e",
1802
      "\xc4\x8d"         => "\xc4\x8c",
1803
      "\xc4\x8b"         => "\xc4\x8a",
1804
      "\xc4\x89"         => "\xc4\x88",
1805
      "\xc4\x87"         => "\xc4\x86",
1806
      "\xc4\x85"         => "\xc4\x84",
1807
      "\xc4\x83"         => "\xc4\x82",
1808
      "\xc4\x81"         => "\xc4\x80",
1809
      "\xc3\xbf"         => "\xc5\xb8",
1810
      "\xc3\xbe"         => "\xc3\x9e",
1811
      "\xc3\xbd"         => "\xc3\x9d",
1812
      "\xc3\xbc"         => "\xc3\x9c",
1813
      "\xc3\xbb"         => "\xc3\x9b",
1814
      "\xc3\xba"         => "\xc3\x9a",
1815
      "\xc3\xb9"         => "\xc3\x99",
1816
      "\xc3\xb8"         => "\xc3\x98",
1817
      "\xc3\xb6"         => "\xc3\x96",
1818
      "\xc3\xb5"         => "\xc3\x95",
1819
      "\xc3\xb4"         => "\xc3\x94",
1820
      "\xc3\xb3"         => "\xc3\x93",
1821
      "\xc3\xb2"         => "\xc3\x92",
1822
      "\xc3\xb1"         => "\xc3\x91",
1823
      "\xc3\xb0"         => "\xc3\x90",
1824
      "\xc3\xaf"         => "\xc3\x8f",
1825
      "\xc3\xae"         => "\xc3\x8e",
1826
      "\xc3\xad"         => "\xc3\x8d",
1827
      "\xc3\xac"         => "\xc3\x8c",
1828
      "\xc3\xab"         => "\xc3\x8b",
1829
      "\xc3\xaa"         => "\xc3\x8a",
1830
      "\xc3\xa9"         => "\xc3\x89",
1831
      "\xc3\xa8"         => "\xc3\x88",
1832
      "\xc3\xa7"         => "\xc3\x87",
1833
      "\xc3\xa6"         => "\xc3\x86",
1834
      "\xc3\xa5"         => "\xc3\x85",
1835
      "\xc3\xa4"         => "\xc3\x84",
1836
      "\xc3\xa3"         => "\xc3\x83",
1837
      "\xc3\xa2"         => "\xc3\x82",
1838
      "\xc3\xa1"         => "\xc3\x81",
1839
      "\xc3\xa0"         => "\xc3\x80",
1840
      "\xc2\xb5"         => "\xce\x9c",
1841
      "\x7a"             => "\x5a",
1842
      "\x79"             => "\x59",
1843
      "\x78"             => "\x58",
1844
      "\x77"             => "\x57",
1845
      "\x76"             => "\x56",
1846
      "\x75"             => "\x55",
1847
      "\x74"             => "\x54",
1848
      "\x73"             => "\x53",
1849
      "\x72"             => "\x52",
1850
      "\x71"             => "\x51",
1851
      "\x70"             => "\x50",
1852
      "\x6f"             => "\x4f",
1853
      "\x6e"             => "\x4e",
1854
      "\x6d"             => "\x4d",
1855
      "\x6c"             => "\x4c",
1856
      "\x6b"             => "\x4b",
1857
      "\x6a"             => "\x4a",
1858
      "\x69"             => "\x49",
1859
      "\x68"             => "\x48",
1860
      "\x67"             => "\x47",
1861 157
      "\x66"             => "\x46",
1862
      "\x65"             => "\x45",
1863 157
      "\x64"             => "\x44",
1864
      "\x63"             => "\x43",
1865 1
      "\x62"             => "\x42",
1866 1
      "\x61"             => "\x41",
1867 1
1868 1
    );
1869 1
1870 157
    return $case;
1871
  }
1872
1873
  /**
1874
   * This method will auto-detect your server environment for UTF-8 support.
1875
   *
1876
   * INFO: You don't need to run it manually, it will be triggered if it's needed.
1877
   */
1878
  public static function checkForSupport()
1879 8
  {
1880
    if (!isset(self::$support['mbstring'])) {
1881 8
1882
      self::$support['mbstring'] = self::mbstring_loaded();
1883 8
      self::$support['iconv'] = self::iconv_loaded();
1884
      self::$support['intl'] = self::intl_loaded();
1885
      self::$support['intlChar'] = self::intlChar_loaded();
1886
      self::$support['pcre_utf8'] = self::pcre_utf8_support();
1887
    }
1888
  }
1889
1890 8
  /**
1891
   * Generates a UTF-8 encoded character from the given code point.
1892
   *
1893
   * @param    int $code_point The code point for which to generate a character.
1894
   *
1895
   * @return   string|null Multi-Byte character, returns null on failure to encode.
1896
   */
1897
  public static function chr($code_point)
1898
  {
1899
    self::checkForSupport();
1900
1901
    $i = (int)$code_point;
1902 1
1903
    if (self::$support['intlChar'] === true) {
1904 1
      return \IntlChar::chr($code_point);
1905
    }
1906 1
1907
    if ($i !== $code_point) {
1908
      $i = self::hex_to_int($code_point);
1909
    }
1910
1911
    if (!$i) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $i of type integer|false is loosely compared to false; 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...
1912
      return null;
1913
    }
1914
1915
    return self::html_entity_decode("&#{$i};", ENT_QUOTES);
1916
  }
1917
1918
  /**
1919
   * Applies callback to all characters of a string.
1920
   *
1921 2
   * @param  string|array $callback The callback function.
1922
   * @param  string       $str      UTF-8 string to run callback on.
1923 2
   *
1924 2
   * @return array The outcome of callback.
1925
   */
1926
  public static function chr_map($callback, $str)
1927 2
  {
1928
    $chars = self::split($str);
1929
1930
    return array_map($callback, $chars);
1931
  }
1932
1933
  /**
1934
   * Generates an array of byte length of each character of a Unicode string.
1935
   *
1936
   * 1 byte => U+0000  - U+007F
1937 2
   * 2 byte => U+0080  - U+07FF
1938
   * 3 byte => U+0800  - U+FFFF
1939 2
   * 4 byte => U+10000 - U+10FFFF
1940 2
   *
1941 2
   * @param    string $str The original Unicode string.
1942
   *
1943 2
   * @return   array An array of byte lengths of each character.
1944
   */
1945 2
  public static function chr_size_list($str)
1946
  {
1947
    if (!$str) {
1948 2
      return array();
1949
    }
1950 2
1951 2
    return array_map('strlen', self::split($str));
1952 2
  }
1953
1954 1
  /**
1955 1
   * Get a decimal code representation of a specific character.
1956 1
   *
1957
   * @param   string $char The input character
1958
   *
1959
   * @return  int
1960
   */
1961
  public static function chr_to_decimal($char)
1962 2
  {
1963
    $char = (string)$char;
1964 2
    $code = self::ord($char[0]);
1965 2
    $bytes = 1;
1966
1967 2
    if (!($code & 0x80)) {
1968
      // 0xxxxxxx
1969
      return $code;
1970
    }
1971
1972
    if (($code & 0xe0) === 0xc0) {
1973
      // 110xxxxx
1974
      $bytes = 2;
1975
      $code &= ~0xc0;
1976
    } elseif (($code & 0xf0) === 0xe0) {
1977
      // 1110xxxx
1978
      $bytes = 3;
1979
      $code &= ~0xe0;
1980
    } elseif (($code & 0xf8) === 0xf0) {
1981
      // 11110xxx
1982
      $bytes = 4;
1983
      $code &= ~0xf0;
1984
    }
1985
1986
    for ($i = 2; $i <= $bytes; $i++) {
1987
      // 10xxxxxx
1988
      $code = ($code << 6) + (self::ord($char[$i - 1]) & ~0x80);
1989
    }
1990
1991
    return $code;
1992
  }
1993 1
1994
  /**
1995 1
   * Get hexadecimal code point (U+xxxx) of a UTF-8 encoded character.
1996
   *
1997
   * @param    string $char The input character
1998
   * @param    string $pfix
1999
   *
2000
   * @return   string The code point encoded as U+xxxx
2001
   */
2002
  public static function chr_to_hex($char, $pfix = 'U+')
2003
  {
2004
    return self::int_to_hex(self::ord($char), $pfix);
2005
  }
2006
2007
  /**
2008
   * Splits a string into smaller chunks and multiple lines, using the specified line ending character.
2009 35
   *
2010
   * @param    string $body     The original string to be split.
2011
   * @param    int    $chunklen The maximum character length of a chunk.
2012
   * @param    string $end      The character(s) to be inserted at the end of each chunk.
2013
   *
2014
   * @return   string The chunked string
2015
   */
2016
  public static function chunk_split($body, $chunklen = 76, $end = "\r\n")
2017
  {
2018
    return implode($end, self::split($body, $chunklen));
2019
  }
2020
2021
  /**
2022
   * Accepts a string and removes all non-UTF-8 characters from it + extras if needed.
2023
   *
2024 35
   * @param string $str                     The string to be sanitized.
2025 35
   * @param bool   $remove_bom
2026
   * @param bool   $normalize_whitespace
2027 35
   * @param bool   $normalize_msword        e.g.: "…" => "..."
2028 35
   * @param bool   $keep_non_breaking_space set true, to keep non-breaking-spaces
2029
   *
2030 35
   * @return string Clean UTF-8 encoded string
2031 7
   */
2032 7
  public static function clean($str, $remove_bom = false, $normalize_whitespace = false, $normalize_msword = false, $keep_non_breaking_space = false)
2033
  {
2034 35
    // http://stackoverflow.com/questions/1401317/remove-non-utf8-characters-from-string
2035 1
    // caused connection reset problem on larger strings
2036 1
2037
    $regx = '/
2038 35
      (
2039 4
        (?: [\x00-\x7F]               # single-byte sequences   0xxxxxxx
2040 4
        |   [\xC0-\xDF][\x80-\xBF]    # double-byte sequences   110xxxxx 10xxxxxx
2041
        |   [\xE0-\xEF][\x80-\xBF]{2} # triple-byte sequences   1110xxxx 10xxxxxx * 2
2042 35
        |   [\xF0-\xF7][\x80-\xBF]{3} # quadruple-byte sequence 11110xxx 10xxxxxx * 3
2043
        ){1,100}                      # ...one or more times
2044
      )
2045
    | ( [\x80-\xBF] )                 # invalid byte in range 10000000 - 10111111
2046
    | ( [\xC0-\xFF] )                 # invalid byte in range 11000000 - 11111111
2047
    /x';
2048
    $str = preg_replace($regx, '$1', $str);
2049
2050
    $str = self::replace_diamond_question_mark($str, '');
2051
    $str = self::remove_invisible_characters($str);
2052 3
2053
    if ($normalize_whitespace === true) {
2054 3
      $str = self::normalize_whitespace($str, $keep_non_breaking_space);
2055
    }
2056 3
2057 1
    if ($normalize_msword === true) {
2058
      $str = self::normalize_msword($str);
2059
    }
2060
2061 3
    if ($remove_bom === true) {
2062
      $str = self::removeBOM($str);
2063
    }
2064
2065
    return $str;
2066
  }
2067
2068 3
  /**
2069
   * Clean-up a and show only printable UTF-8 chars at the end  + fix UTF-8 encoding.
2070 3
   *
2071
   * @param string $str
2072
   *
2073
   * @return string
2074
   */
2075
  public static function cleanup($str)
2076
  {
2077
    $str = (string)$str;
2078
2079
    if (!isset($str[0])) {
2080
      return '';
2081
    }
2082 3
2083
    // fixed ISO <-> UTF-8 Errors
2084 3
    $str = self::fix_simple_utf8($str);
2085 3
2086 3
    // remove all none UTF-8 symbols
2087
    // && remove diamond question mark (�)
2088 3
    // && remove remove invisible characters (e.g. "\0")
2089
    // && remove BOM
2090 3
    // && normalize whitespace chars (but keep non-breaking-spaces)
2091 3
    $str = self::clean($str, true, true, false, true);
2092 3
2093
    return (string)$str;
2094 3
  }
2095
2096 3
  /**
2097
   * Accepts a string or a array of strings and returns an array of Unicode code points.
2098
   *
2099
   * @param    string|string[] $arg     A UTF-8 encoded string or an array of such strings.
2100
   * @param    bool            $u_style If True, will return code points in U+xxxx format,
2101
   *                                    default, code points will be returned as integers.
2102
   *
2103
   * @return   array The array of code points
2104
   */
2105
  public static function codepoints($arg, $u_style = false)
2106 3
  {
2107
    if (is_string($arg)) {
2108
      $arg = self::split($arg);
2109
    }
2110
2111
    $arg = array_map(
2112
        array(
2113
            '\\voku\\helper\\UTF8',
2114
            'ord',
2115
        ),
2116
        $arg
2117 3
    );
2118
2119 3
    if ($u_style) {
2120
      $arg = array_map(
2121 3
          array(
2122
              '\\voku\\helper\\UTF8',
2123 3
              'int_to_hex',
2124
          ),
2125
          $arg
2126
      );
2127
    }
2128
2129
    return $arg;
2130
  }
2131
2132
  /**
2133 1
   * Returns count of characters used in a string.
2134
   *
2135 1
   * @param    string $str       The input string.
2136
   * @param    bool   $cleanUtf8 Clean non UTF-8 chars from the string.
2137 1
   *
2138 1
   * @return   array An associative array of Character as keys and
2139 1
   *           their count as values.
2140
   */
2141 1
  public static function count_chars($str, $cleanUtf8 = false)
2142
  {
2143
    return array_count_values(self::split($str, 1, $cleanUtf8));
2144
  }
2145
2146
  /**
2147
   * Get a UTF-8 character from its decimal code representation.
2148
   *
2149
   * @param   int $code Code.
2150
   *
2151
   * @return  string
2152
   */
2153
  public static function decimal_to_chr($code)
2154
  {
2155 11
    self::checkForSupport();
2156
2157 11
    return \mb_convert_encoding(
2158
        '&#x' . dechex($code) . ';',
2159 11
        'UTF-8',
2160 11
        'HTML-ENTITIES'
2161
    );
2162
  }
2163 1
2164 1
  /**
2165
   * Encode a string with a new charset-encoding.
2166
   *
2167
   * INFO:  The different to "UTF8::utf8_encode()" is that this function, try to fix also broken / double encoding,
2168
   *        so you can call this function also on a UTF-8 String and you don't mess the string.
2169
   *
2170
   * @param string $encoding e.g. 'UTF-8', 'ISO-8859-1', etc.
2171
   * @param string $str      the string
2172
   * @param bool   $force    force the new encoding (we try to fix broken / double encoding for UTF-8)<br />
2173
   *                         otherwise we auto-detect the current string-encoding
2174
   *
2175
   * @return string
2176
   */
2177
  public static function encode($encoding, $str, $force = true)
2178
  {
2179
    $str = (string)$str;
2180
    $encoding = (string)$encoding;
2181
2182
    if (!isset($str[0], $encoding[0])) {
2183
      return $str;
2184
    }
2185
2186
    $encoding = self::normalizeEncoding($encoding);
2187
    $encodingDetected = self::str_detect_encoding($str);
2188
2189
    if (
2190
        $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...
2191
        &&
2192
        (
2193
            $force === true
2194
            ||
2195
            $encodingDetected !== $encoding
2196
        )
2197
    ) {
2198
      self::checkForSupport();
2199
2200 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...
2201
          $encoding === 'UTF-8'
2202
          &&
2203
          (
2204
              $force === true
2205
              || $encodingDetected === 'UTF-8'
2206
              || $encodingDetected === 'WINDOWS-1252'
2207
              || $encodingDetected === 'ISO-8859-1'
2208
          )
2209
      ) {
2210
        return self::to_utf8($str);
2211
      }
2212
2213 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...
2214
          $encoding === 'ISO-8859-1'
2215
          &&
2216
          (
2217
              $force === true
2218
              || $encodingDetected === 'ISO-8859-1'
2219
              || $encodingDetected === 'UTF-8'
2220
          )
2221
      ) {
2222
        return self::to_win1252($str);
2223
      }
2224
2225
      $strEncoded = \mb_convert_encoding(
2226
          $str,
2227
          $encoding,
2228
          $encodingDetected
2229
      );
2230
2231
      if ($strEncoded) {
2232
        return $strEncoded;
2233
      }
2234
    }
2235
2236
    return $str;
2237
  }
2238
2239
  /**
2240
   * Callback function for preg_replace_callback use.
2241
   *
2242
   * @internal used for "UTF8::html_entity_decode()"
2243
   *
2244
   * @param  array $matches PREG matches
2245
   *
2246
   * @return string
2247
   */
2248
  protected static function html_entity_decode_callback($matches)
2249
  {
2250
    self::checkForSupport();
2251
2252 2
    $return = \mb_convert_encoding($matches[0], 'UTF-8', 'HTML-ENTITIES');
2253
2254
    if ($return === "'") {
2255 2
      return '&#x27;';
2256 2
    }
2257
2258 2
    return $return;
2259 2
  }
2260
2261
  /**
2262
   * Reads entire file into a string.
2263 2
   *
2264 2
   * WARNING: do not use UTF-8 Option ($convertToUtf8) for binary-files (e.g.: images) !!!
2265
   *
2266 2
   * @link http://php.net/manual/en/function.file-get-contents.php
2267 2
   *
2268
   * @param string        $filename      <p>
2269 2
   *                                     Name of the file to read.
2270 1
   *                                     </p>
2271 1
   * @param int|null      $flags         [optional] <p>
2272 2
   *                                     Prior to PHP 6, this parameter is called
2273
   *                                     use_include_path and is a bool.
2274
   *                                     As of PHP 5 the FILE_USE_INCLUDE_PATH can be used
2275
   *                                     to trigger include path
2276 2
   *                                     search.
2277
   *                                     </p>
2278
   *                                     <p>
2279
   *                                     The value of flags can be any combination of
2280 2
   *                                     the following flags (with some restrictions), joined with the
2281 2
   *                                     binary OR (|)
2282
   *                                     operator.
2283 2
   *                                     </p>
2284
   *                                     <p>
2285 2
   *                                     <table>
2286 1
   *                                     Available flags
2287 1
   *                                     <tr valign="top">
2288 1
   *                                     <td>Flag</td>
2289 1
   *                                     <td>Description</td>
2290 1
   *                                     </tr>
2291 1
   *                                     <tr valign="top">
2292
   *                                     <td>
2293 2
   *                                     FILE_USE_INCLUDE_PATH
2294 2
   *                                     </td>
2295 2
   *                                     <td>
2296 2
   *                                     Search for filename in the include directory.
2297
   *                                     See include_path for more
2298
   *                                     information.
2299 2
   *                                     </td>
2300
   *                                     </tr>
2301
   *                                     <tr valign="top">
2302
   *                                     <td>
2303
   *                                     FILE_TEXT
2304
   *                                     </td>
2305
   *                                     <td>
2306
   *                                     As of PHP 6, the default encoding of the read
2307
   *                                     data is UTF-8. You can specify a different encoding by creating a
2308
   *                                     custom context or by changing the default using
2309 1
   *                                     stream_default_encoding. This flag cannot be
2310
   *                                     used with FILE_BINARY.
2311 1
   *                                     </td>
2312
   *                                     </tr>
2313
   *                                     <tr valign="top">
2314
   *                                     <td>
2315
   *                                     FILE_BINARY
2316
   *                                     </td>
2317
   *                                     <td>
2318
   *                                     With this flag, the file is read in binary mode. This is the default
2319
   *                                     setting and cannot be used with FILE_TEXT.
2320
   *                                     </td>
2321
   *                                     </tr>
2322
   *                                     </table>
2323 7
   *                                     </p>
2324
   * @param resource|null $context       [optional] <p>
2325 7
   *                                     A valid context resource created with
2326 7
   *                                     stream_context_create. If you don't need to use a
2327 2
   *                                     custom context, you can skip this parameter by &null;.
2328
   *                                     </p>
2329 1
   * @param int|null      $offset        [optional] <p>
2330 2
   *                                     The offset where the reading starts.
2331 2
   *                                     </p>
2332 7
   * @param int|null      $maxlen        [optional] <p>
2333 1
   *                                     Maximum length of data read. The default is to read until end
2334 1
   *                                     of file is reached.
2335 1
   *                                     </p>
2336 1
   * @param int           $timeout
2337 7
   *
2338 7
   * @param boolean       $convertToUtf8 WARNING: maybe you can't use this option for images or pdf, because they used
2339
   *                                     non default utf-8 chars
2340
   *
2341
   * @return string The function returns the read data or false on failure.
2342 7
   */
2343 7
  public static function file_get_contents($filename, $flags = null, $context = null, $offset = null, $maxlen = null, $timeout = 10, $convertToUtf8 = true)
2344 1
  {
2345 1
    // init
2346 7
    $timeout = (int)$timeout;
2347
    $filename = filter_var($filename, FILTER_SANITIZE_STRING);
2348 7
2349 5
    if ($timeout && $context === null) {
2350 5
      $context = stream_context_create(
2351 4
          array(
2352
              'http' =>
2353
                  array(
2354
                      'timeout' => $timeout,
2355 7
                  ),
2356
          )
2357
      );
2358
    }
2359
2360 7
    if (is_int($maxlen)) {
2361 7
      $data = file_get_contents($filename, $flags, $context, $offset, $maxlen);
2362 7
    } else {
2363
      $data = file_get_contents($filename, $flags, $context, $offset);
2364 7
    }
2365
2366
    // return false on error
2367
    if ($data === false) {
2368
      return false;
2369
    }
2370
2371
    if ($convertToUtf8 === true) {
2372
      self::checkForSupport();
2373
2374
      $data = self::encode('UTF-8', $data, false);
2375
      $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...
2376
    }
2377
2378
    // clean utf-8 string
2379
    return $data;
2380
  }
2381
2382
  /**
2383
   * Checks if a file starts with BOM (Byte Order Mark) character.
2384
   *
2385
   * @param    string $file_path Path to a valid file.
2386
   *
2387
   * @return   bool True if the file has BOM at the start, False otherwise.
2388
   */
2389
  public static function file_has_bom($file_path)
2390
  {
2391
    return self::string_has_bom(file_get_contents($file_path));
2392
  }
2393
2394
  /**
2395
   * Normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
2396
   *
2397
   * @param mixed  $var
2398
   * @param int    $normalization_form
2399
   * @param string $leading_combining
2400
   *
2401
   * @return mixed
2402
   */
2403
  public static function filter($var, $normalization_form = 4 /* n::NFC */, $leading_combining = '◌')
2404
  {
2405
    switch (gettype($var)) {
2406 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...
2407
        foreach ($var as $k => $v) {
2408
          /** @noinspection AlterInForeachInspection */
2409
          $var[$k] = self::filter($v, $normalization_form, $leading_combining);
2410
        }
2411
        break;
2412 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...
2413
        foreach ($var as $k => $v) {
2414
          $var->{$k} = self::filter($v, $normalization_form, $leading_combining);
2415
        }
2416
        break;
2417 1
      case 'string':
2418
        if (false !== strpos($var, "\r")) {
2419 1
          // Workaround https://bugs.php.net/65732
2420 1
          $var = str_replace(array("\r\n", "\r"), "\n", $var);
2421 1
        }
2422 1
        if (preg_match('/[\x80-\xFF]/', $var)) {
2423
          if (\Normalizer::isNormalized($var, $normalization_form)) {
2424
            $n = '-';
2425 1
          } else {
2426
            $n = \Normalizer::normalize($var, $normalization_form);
2427
2428
            if (isset($n[0])) {
2429
              $var = $n;
2430
            } else {
2431
              $var = self::encode('UTF-8', $var);
2432
            }
2433
2434
          }
2435
          if ($var[0] >= "\x80" && isset($n[0], $leading_combining[0]) && preg_match('/^\p{Mn}/u', $var)) {
2436
            // Prevent leading combining chars
2437 1
            // for NFC-safe concatenations.
2438
            $var = $leading_combining . $var;
2439 1
          }
2440 1
        }
2441 1
        break;
2442 1
    }
2443
2444
    return $var;
2445 1
  }
2446
2447
  /**
2448
   * "filter_input()"-wrapper with normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
2449
   *
2450
   * @param int    $type
2451
   * @param string $var
2452
   * @param int    $filter
2453
   * @param mixed  $option
2454
   *
2455
   * @return mixed
2456
   */
2457 1 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...
2458
  {
2459 1
    if (4 > func_num_args()) {
2460
      $var = filter_input($type, $var, $filter);
2461
    } else {
2462
      $var = filter_input($type, $var, $filter, $option);
2463
    }
2464
2465
    return self::filter($var);
2466
  }
2467
2468
  /**
2469 8
   * "filter_input_array()"-wrapper with normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
2470
   *
2471 8
   * @param int   $type
2472 8
   * @param mixed $definition
2473
   * @param bool  $add_empty
2474 8
   *
2475
   * @return mixed
2476 8
   */
2477 2 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...
2478
  {
2479
    if (2 > func_num_args()) {
2480 8
      $a = filter_input_array($type);
2481 1
    } else {
2482 1
      $a = filter_input_array($type, $definition, $add_empty);
2483 1
    }
2484
2485 8
    return self::filter($a);
2486
  }
2487
2488
  /**
2489
   * "filter_var()"-wrapper with normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
2490
   *
2491
   * @param mixed $var
2492
   * @param int   $filter
2493
   * @param mixed $option
2494
   *
2495 1
   * @return mixed
2496
   */
2497 1 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...
2498
  {
2499
    if (3 > func_num_args()) {
2500
      $var = filter_var($var, $filter);
2501
    } else {
2502
      $var = filter_var($var, $filter, $option);
2503
    }
2504
2505
    return self::filter($var);
2506
  }
2507 1
2508 1
  /**
2509 1
   * "filter_var_array()"-wrapper with normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
2510 1
   *
2511 1
   * @param array $data
2512
   * @param mixed $definition
2513 1
   * @param bool  $add_empty
2514
   *
2515
   * @return mixed
2516
   */
2517 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...
2518
  {
2519
    if (2 > func_num_args()) {
2520
      $a = filter_var_array($data);
2521
    } else {
2522
      $a = filter_var_array($data, $definition, $add_empty);
2523 1
    }
2524
2525 1
    return self::filter($a);
2526
  }
2527 1
2528 1
  /**
2529
   * Check if the number of unicode characters are not more than the specified integer.
2530
   *
2531 1
   * @param    string $str      The original string to be checked.
2532
   * @param    int    $box_size The size in number of chars to be checked against string.
2533 1
   *
2534 1
   * @return   bool true if string is less than or equal to $box_size, false otherwise.
2535 1
   */
2536 1
  public static function fits_inside($str, $box_size)
2537 1
  {
2538 1
    return (self::strlen($str) <= $box_size);
2539 1
  }
2540 1
2541 1
  /**
2542 1
   * Try to fix simple broken UTF-8 strings.
2543 1
   *
2544
   * INFO: Take a look at "UTF8::fix_utf8()" if you need a more advanced fix for broken UTF-8 strings.
2545
   *
2546
   * @param string $str
2547
   *
2548
   * @return string
2549
   */
2550
  public static function fix_simple_utf8($str)
2551
  {
2552
    static $brokenUtf8ToUtf8Keys = null;
2553
    static $brokenUtf8ToUtf8Values = null;
2554
2555
    $str = (string)$str;
2556
2557
    if (!isset($str[0])) {
2558
      return '';
2559
    }
2560
2561
    if ($brokenUtf8ToUtf8Keys === null) {
2562
      $brokenUtf8ToUtf8Keys = array_keys(self::$brokenUtf8ToUtf8);
2563 1
      $brokenUtf8ToUtf8Values = array_values(self::$brokenUtf8ToUtf8);
2564 1
    }
2565
2566
    return str_replace($brokenUtf8ToUtf8Keys, $brokenUtf8ToUtf8Values, $str);
2567
  }
2568
2569
  /**
2570
   * Fix a double (or multiple) encoded UTF8 string.
2571
   *
2572
   * @param string|string[] $str You can use a string or an array of strings.
2573
   *
2574
   * @return mixed
2575
   */
2576
  public static function fix_utf8($str)
2577
  {
2578
    if (is_array($str)) {
2579
2580
      foreach ($str as $k => $v) {
2581
        /** @noinspection AlterInForeachInspection */
2582
        /** @noinspection OffsetOperationsInspection */
2583
        $str[$k] = self::fix_utf8($v);
2584
      }
2585
2586
      return $str;
2587
    }
2588
2589
    $last = '';
2590
    while ($last !== $str) {
2591
      $last = $str;
2592
      $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 2592 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...
2593
    }
2594
2595
    return $str;
2596
  }
2597
2598
  /**
2599
   * Get character of a specific character.
2600
   *
2601
   * @param   string $char Character.
2602
   *
2603
   * @return  string 'RTL' or 'LTR'
2604
   */
2605
  public static function getCharDirection($char)
2606
  {
2607
    // init
2608
    self::checkForSupport();
2609
2610
    if (self::$support['intlChar'] === true) {
2611
      $tmpReturn = \IntlChar::charDirection($char);
2612
2613
      // from "IntlChar"-Class
2614
      $charDirection = array(
2615
          'RTL' => array(1, 13, 14, 15, 21),
2616
          'LTR' => array(0, 11, 12, 20),
2617
      );
2618
2619
      if (in_array($tmpReturn, $charDirection['LTR'], true)) {
2620
        return 'LTR';
2621
      } elseif (in_array($tmpReturn, $charDirection['RTL'], true)) {
2622
        return 'RTL';
2623 2
      }
2624
    }
2625 2
2626 2
    $c = static::chr_to_decimal($char);
2627 2
2628
    if (!(0x5be <= $c && 0x10b7f >= $c)) {
2629
      return 'LTR';
2630
    }
2631
2632
    if (0x85e >= $c) {
2633
2634
      if (0x5be === $c ||
2635
          0x5c0 === $c ||
2636
          0x5c3 === $c ||
2637
          0x5c6 === $c ||
2638
          (0x5d0 <= $c && 0x5ea >= $c) ||
2639
          (0x5f0 <= $c && 0x5f4 >= $c) ||
2640 1
          0x608 === $c ||
2641
          0x60b === $c ||
2642 1
          0x60d === $c ||
2643 1
          0x61b === $c ||
2644
          (0x61e <= $c && 0x64a >= $c) ||
2645 1
          (0x66d <= $c && 0x66f >= $c) ||
2646 1
          (0x671 <= $c && 0x6d5 >= $c) ||
2647
          (0x6e5 <= $c && 0x6e6 >= $c) ||
2648
          (0x6ee <= $c && 0x6ef >= $c) ||
2649
          (0x6fa <= $c && 0x70d >= $c) ||
2650 1
          0x710 === $c ||
2651
          (0x712 <= $c && 0x72f >= $c) ||
2652 1
          (0x74d <= $c && 0x7a5 >= $c) ||
2653 1
          0x7b1 === $c ||
2654 1
          (0x7c0 <= $c && 0x7ea >= $c) ||
2655
          (0x7f4 <= $c && 0x7f5 >= $c) ||
2656 1
          0x7fa === $c ||
2657 1
          (0x800 <= $c && 0x815 >= $c) ||
2658 1
          0x81a === $c ||
2659 1
          0x824 === $c ||
2660 1
          0x828 === $c ||
2661
          (0x830 <= $c && 0x83e >= $c) ||
2662 1
          (0x840 <= $c && 0x858 >= $c) ||
2663
          0x85e === $c
2664 1
      ) {
2665 1
        return 'RTL';
2666
      }
2667
2668
    } elseif (0x200f === $c) {
2669 1
2670 1
      return 'RTL';
2671
2672 1
    } elseif (0xfb1d <= $c) {
2673
2674 1
      if (0xfb1d === $c ||
2675 1
          (0xfb1f <= $c && 0xfb28 >= $c) ||
2676 1
          (0xfb2a <= $c && 0xfb36 >= $c) ||
2677
          (0xfb38 <= $c && 0xfb3c >= $c) ||
2678 1
          0xfb3e === $c ||
2679
          (0xfb40 <= $c && 0xfb41 >= $c) ||
2680
          (0xfb43 <= $c && 0xfb44 >= $c) ||
2681
          (0xfb46 <= $c && 0xfbc1 >= $c) ||
2682
          (0xfbd3 <= $c && 0xfd3d >= $c) ||
2683
          (0xfd50 <= $c && 0xfd8f >= $c) ||
2684
          (0xfd92 <= $c && 0xfdc7 >= $c) ||
2685
          (0xfdf0 <= $c && 0xfdfc >= $c) ||
2686
          (0xfe70 <= $c && 0xfe74 >= $c) ||
2687
          (0xfe76 <= $c && 0xfefc >= $c) ||
2688
          (0x10800 <= $c && 0x10805 >= $c) ||
2689
          0x10808 === $c ||
2690
          (0x1080a <= $c && 0x10835 >= $c) ||
2691
          (0x10837 <= $c && 0x10838 >= $c) ||
2692
          0x1083c === $c ||
2693
          (0x1083f <= $c && 0x10855 >= $c) ||
2694
          (0x10857 <= $c && 0x1085f >= $c) ||
2695
          (0x10900 <= $c && 0x1091b >= $c) ||
2696
          (0x10920 <= $c && 0x10939 >= $c) ||
2697
          0x1093f === $c ||
2698
          0x10a00 === $c ||
2699
          (0x10a10 <= $c && 0x10a13 >= $c) ||
2700
          (0x10a15 <= $c && 0x10a17 >= $c) ||
2701
          (0x10a19 <= $c && 0x10a33 >= $c) ||
2702
          (0x10a40 <= $c && 0x10a47 >= $c) ||
2703
          (0x10a50 <= $c && 0x10a58 >= $c) ||
2704
          (0x10a60 <= $c && 0x10a7f >= $c) ||
2705
          (0x10b00 <= $c && 0x10b35 >= $c) ||
2706
          (0x10b40 <= $c && 0x10b55 >= $c) ||
2707
          (0x10b58 <= $c && 0x10b72 >= $c) ||
2708 1
          (0x10b78 <= $c && 0x10b7f >= $c)
2709
      ) {
2710 1
        return 'RTL';
2711 1
      }
2712
    }
2713 1
2714 1
    return 'LTR';
2715 1
  }
2716 1
2717 1
  /**
2718 1
   * get data from "/data/*.ser"
2719
   *
2720
   * @param string $file
2721
   *
2722
   * @return bool|string|array|int false on error
2723
   */
2724
  protected static function getData($file)
2725
  {
2726
    $file = __DIR__ . '/data/' . $file . '.php';
2727
    if (file_exists($file)) {
2728
      /** @noinspection PhpIncludeInspection */
2729
      return require $file;
2730
    } else {
2731
      return false;
2732
    }
2733
  }
2734
2735
  /**
2736
   * Creates a random string of UTF-8 characters.
2737
   *
2738
   * WARNING: This method does not create a hash of something, maybe it will be renamed in future.
2739
   *
2740
   * @param    int $len The length of string in characters.
2741
   *
2742
   * @return   string String consisting of random characters.
2743
   *
2744
   * @deprecated
2745
   */
2746
  public static function hash($len = 8)
2747
  {
2748
    static $chars = array();
2749
    static $chars_len = null;
2750
2751
    if ($len <= 0) {
2752
      return '';
2753
    }
2754
2755
    // init
2756
    self::checkForSupport();
2757
2758
    if (!$chars) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $chars of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
2759
      if (self::$support['pcre_utf8'] === true) {
2760
        $chars = array_map(
2761
            array(
2762
                '\\voku\\helper\\UTF8',
2763
                'chr',
2764
            ),
2765
            range(48, 79)
2766
        );
2767
2768
        $chars = preg_replace('/[^\p{N}\p{Lu}\p{Ll}]/u', '', $chars);
2769
2770
        $chars = array_values(array_filter($chars));
2771
      } else {
2772
        $chars = array_merge(range('0', '9'), range('A', 'Z'), range('a', 'z'));
2773
      }
2774
2775
      $chars_len = count($chars);
2776
    }
2777
2778
    $hash = '';
2779
2780
    for (; $len; --$len) {
2781
      $hash .= $chars[mt_rand() % $chars_len];
2782
    }
2783
2784
    return $hash;
2785
  }
2786
2787
  /**
2788
   * Converts hexadecimal U+xxxx code point representation to integer.
2789
   *
2790 15
   * INFO: opposite to UTF8::int_to_hex()
2791
   *
2792 15
   * @param    string $str The hexadecimal code point representation.
2793
   *
2794 15
   * @return   int|false The code point, or false on failure.
2795 3
   */
2796
  public static function hex_to_int($str)
2797
  {
2798 15
    if (preg_match('/^(?:\\\u|U\+|)([a-z0-9]{4,6})$/i', $str, $match)) {
2799 4
      return intval($match[1], 16);
2800
    }
2801
2802 15
    return false;
2803 3
  }
2804 3
2805 3
  /**
2806
   * alias for "UTF8::html_entity_decode()"
2807
   *
2808 3
   * @param string $str
2809
   * @param int    $flags
2810
   * @param string $encoding
2811 15
   *
2812
   * @return string
2813 15
   */
2814
  public static function html_decode($str, $flags = null, $encoding = 'UTF-8')
2815
  {
2816 15
    return self::html_entity_decode($str, $flags, $encoding);
2817 15
  }
2818 15
2819
  /**
2820 15
   * Converts a UTF-8 string to a series of HTML numbered entities.
2821
   *
2822 15
   * INFO: opposite to UTF8::html_decode()
2823
   *
2824 15
   * @param  string $str            The Unicode string to be encoded as numbered entities.
2825
   * @param  bool   $keepAsciiChars Keep ASCII chars.
2826
   * @param  string $encoding
2827
   *
2828
   * @return string HTML numbered entities.
2829
   */
2830
  public static function html_encode($str, $keepAsciiChars = false, $encoding = 'UTF-8')
2831
  {
2832
    # INFO: http://stackoverflow.com/questions/35854535/better-explanation-of-convmap-in-mb-encode-numericentity
2833
    if (function_exists('mb_encode_numericentity')) {
2834 12
2835
      $startCode = 0x00;
2836 12
      if ($keepAsciiChars === true) {
2837
        $startCode = 0x80;
2838 12
      }
2839
2840 12
      $encoding = self::normalizeEncoding($encoding);
2841 5
2842
      return mb_encode_numericentity(
2843
          $str,
2844 11
          array($startCode, 0xffff, 0, 0xffff,),
2845
          $encoding
2846
      );
2847
    }
2848
2849
    return implode(
2850
        array_map(
2851
            function ($data) use ($keepAsciiChars) {
2852
              return UTF8::single_chr_html_encode($data, $keepAsciiChars);
2853
            },
2854
            self::split($str)
2855
        )
2856
    );
2857
  }
2858
2859
  /**
2860
   * UTF-8 version of html_entity_decode()
2861
   *
2862
   * The reason we are not using html_entity_decode() by itself is because
2863
   * while it is not technically correct to leave out the semicolon
2864
   * at the end of an entity most browsers will still interpret the entity
2865
   * correctly. html_entity_decode() does not convert entities without
2866
   * semicolons, so we are left with our own little solution here. Bummer.
2867
   *
2868
   * Convert all HTML entities to their applicable characters
2869
   *
2870
   * INFO: opposite to UTF8::html_encode()
2871
   *
2872
   * @link http://php.net/manual/en/function.html-entity-decode.php
2873
   *
2874
   * @param string $str      <p>
2875
   *                         The input string.
2876
   *                         </p>
2877
   * @param int    $flags    [optional] <p>
2878
   *                         A bitmask of one or more of the following flags, which specify how to handle quotes and
2879
   *                         which document type to use. The default is ENT_COMPAT | ENT_HTML401.
2880
   *                         <table>
2881
   *                         Available <i>flags</i> constants
2882
   *                         <tr valign="top">
2883
   *                         <td>Constant Name</td>
2884
   *                         <td>Description</td>
2885
   *                         </tr>
2886
   *                         <tr valign="top">
2887
   *                         <td><b>ENT_COMPAT</b></td>
2888
   *                         <td>Will convert double-quotes and leave single-quotes alone.</td>
2889
   *                         </tr>
2890
   *                         <tr valign="top">
2891
   *                         <td><b>ENT_QUOTES</b></td>
2892
   *                         <td>Will convert both double and single quotes.</td>
2893
   *                         </tr>
2894
   *                         <tr valign="top">
2895
   *                         <td><b>ENT_NOQUOTES</b></td>
2896
   *                         <td>Will leave both double and single quotes unconverted.</td>
2897
   *                         </tr>
2898
   *                         <tr valign="top">
2899
   *                         <td><b>ENT_HTML401</b></td>
2900
   *                         <td>
2901
   *                         Handle code as HTML 4.01.
2902
   *                         </td>
2903
   *                         </tr>
2904
   *                         <tr valign="top">
2905
   *                         <td><b>ENT_XML1</b></td>
2906
   *                         <td>
2907
   *                         Handle code as XML 1.
2908
   *                         </td>
2909
   *                         </tr>
2910
   *                         <tr valign="top">
2911
   *                         <td><b>ENT_XHTML</b></td>
2912
   *                         <td>
2913
   *                         Handle code as XHTML.
2914
   *                         </td>
2915
   *                         </tr>
2916
   *                         <tr valign="top">
2917
   *                         <td><b>ENT_HTML5</b></td>
2918
   *                         <td>
2919
   *                         Handle code as HTML 5.
2920
   *                         </td>
2921
   *                         </tr>
2922
   *                         </table>
2923
   *                         </p>
2924
   * @param string $encoding [optional] <p>
2925
   *                         Encoding to use.
2926
   *                         </p>
2927
   *
2928
   * @return string the decoded string.
2929
   */
2930
  public static function html_entity_decode($str, $flags = null, $encoding = 'UTF-8')
2931
  {
2932
    $str = (string)$str;
2933
2934
    if (!isset($str[0])) {
2935
      return '';
2936
    }
2937
2938
    if (strpos($str, '&') === false) {
2939
      return $str;
2940
    }
2941
2942
    $encoding = self::normalizeEncoding($encoding);
2943
2944
    if ($flags === null) {
2945
      if (Bootup::is_php('5.4') === true) {
2946
        $flags = ENT_COMPAT | ENT_HTML5;
2947
      } else {
2948
        $flags = ENT_COMPAT;
2949
      }
2950 2
    }
2951
2952 2
    do {
2953
      $str_compare = $str;
2954
2955
      $str = preg_replace_callback("/&#\d{2,5};/", array('\voku\helper\UTF8', 'html_entity_decode_callback'), $str);
2956
2957
      // decode numeric & UTF16 two byte entities
2958
      $str = html_entity_decode(
2959
          preg_replace('/(&#(?:x0*[0-9a-f]{2,5}(?![0-9a-f;])|(?:0*\d{2,4}(?![0-9;]))))/iS', '$1;', $str),
2960
          $flags,
2961
          $encoding
2962
      );
2963
2964
    } while ($str_compare !== $str);
2965
2966
    return $str;
2967
  }
2968
2969
  /**
2970
   * Convert all applicable characters to HTML entities: UTF-8 version of htmlentities()
2971
   *
2972
   * @link http://php.net/manual/en/function.htmlentities.php
2973
   *
2974
   * @param string $str           <p>
2975
   *                              The input string.
2976
   *                              </p>
2977
   * @param int    $flags         [optional] <p>
2978
   *                              A bitmask of one or more of the following flags, which specify how to handle quotes,
2979
   *                              invalid code unit sequences and the used document type. The default is
2980
   *                              ENT_COMPAT | ENT_HTML401.
2981
   *                              <table>
2982
   *                              Available <i>flags</i> constants
2983
   *                              <tr valign="top">
2984
   *                              <td>Constant Name</td>
2985
   *                              <td>Description</td>
2986
   *                              </tr>
2987
   *                              <tr valign="top">
2988
   *                              <td><b>ENT_COMPAT</b></td>
2989
   *                              <td>Will convert double-quotes and leave single-quotes alone.</td>
2990
   *                              </tr>
2991
   *                              <tr valign="top">
2992
   *                              <td><b>ENT_QUOTES</b></td>
2993
   *                              <td>Will convert both double and single quotes.</td>
2994
   *                              </tr>
2995
   *                              <tr valign="top">
2996
   *                              <td><b>ENT_NOQUOTES</b></td>
2997
   *                              <td>Will leave both double and single quotes unconverted.</td>
2998
   *                              </tr>
2999
   *                              <tr valign="top">
3000
   *                              <td><b>ENT_IGNORE</b></td>
3001
   *                              <td>
3002
   *                              Silently discard invalid code unit sequences instead of returning
3003
   *                              an empty string. Using this flag is discouraged as it
3004
   *                              may have security implications.
3005
   *                              </td>
3006
   *                              </tr>
3007
   *                              <tr valign="top">
3008
   *                              <td><b>ENT_SUBSTITUTE</b></td>
3009
   *                              <td>
3010
   *                              Replace invalid code unit sequences with a Unicode Replacement Character
3011
   *                              U+FFFD (UTF-8) or &#38;#38;#FFFD; (otherwise) instead of returning an empty string.
3012
   *                              </td>
3013
   *                              </tr>
3014
   *                              <tr valign="top">
3015
   *                              <td><b>ENT_DISALLOWED</b></td>
3016
   *                              <td>
3017
   *                              Replace invalid code points for the given document type with a
3018
   *                              Unicode Replacement Character U+FFFD (UTF-8) or &#38;#38;#FFFD;
3019
   *                              (otherwise) instead of leaving them as is. This may be useful, for
3020
   *                              instance, to ensure the well-formedness of XML documents with
3021
   *                              embedded external content.
3022
   *                              </td>
3023
   *                              </tr>
3024
   *                              <tr valign="top">
3025
   *                              <td><b>ENT_HTML401</b></td>
3026
   *                              <td>
3027
   *                              Handle code as HTML 4.01.
3028
   *                              </td>
3029
   *                              </tr>
3030
   *                              <tr valign="top">
3031
   *                              <td><b>ENT_XML1</b></td>
3032
   *                              <td>
3033
   *                              Handle code as XML 1.
3034
   *                              </td>
3035
   *                              </tr>
3036
   *                              <tr valign="top">
3037
   *                              <td><b>ENT_XHTML</b></td>
3038
   *                              <td>
3039
   *                              Handle code as XHTML.
3040
   *                              </td>
3041
   *                              </tr>
3042
   *                              <tr valign="top">
3043
   *                              <td><b>ENT_HTML5</b></td>
3044
   *                              <td>
3045
   *                              Handle code as HTML 5.
3046
   *                              </td>
3047
   *                              </tr>
3048
   *                              </table>
3049
   *                              </p>
3050
   * @param string $encoding      [optional] <p>
3051
   *                              Like <b>htmlspecialchars</b>,
3052
   *                              <b>htmlentities</b> takes an optional third argument
3053
   *                              <i>encoding</i> which defines encoding used in
3054
   *                              conversion.
3055
   *                              Although this argument is technically optional, you are highly
3056
   *                              encouraged to specify the correct value for your code.
3057
   *                              </p>
3058
   * @param bool   $double_encode [optional] <p>
3059
   *                              When <i>double_encode</i> is turned off PHP will not
3060
   *                              encode existing html entities. The default is to convert everything.
3061
   *                              </p>
3062 1
   *
3063
   *
3064 1
   * @return string the encoded string.
3065
   * </p>
3066
   * <p>
3067
   * If the input <i>string</i> contains an invalid code unit
3068
   * sequence within the given <i>encoding</i> an empty string
3069
   * will be returned, unless either the <b>ENT_IGNORE</b> or
3070
   * <b>ENT_SUBSTITUTE</b> flags are set.
3071
   */
3072 1
  public static function htmlentities($str, $flags = ENT_COMPAT, $encoding = 'UTF-8', $double_encode = true)
3073
  {
3074 1
    $encoding = self::normalizeEncoding($encoding);
3075
3076
    $str = htmlentities($str, $flags, $encoding, $double_encode);
3077
3078
    if ($encoding !== 'UTF-8') {
3079
      return $str;
3080
    }
3081
3082
    $byteLengths = self::chr_size_list($str);
3083
    $search = array();
3084
    $replacements = array();
3085
    foreach ($byteLengths as $counter => $byteLength) {
3086
      if ($byteLength >= 3) {
3087
        $char = self::access($str, $counter);
3088
3089
        if (!isset($replacements[$char])) {
3090
          $search[$char] = $char;
3091
          $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 3087 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...
3092
        }
3093
      }
3094
    }
3095
3096
    return str_replace($search, $replacements, $str);
3097
  }
3098
3099
  /**
3100
   * Convert only special characters to HTML entities: UTF-8 version of htmlspecialchars()
3101
   *
3102
   * INFO: Take a look at "UTF8::htmlentities()"
3103 1
   *
3104
   * @link http://php.net/manual/en/function.htmlspecialchars.php
3105 1
   *
3106
   * @param string $str           <p>
3107
   *                              The string being converted.
3108
   *                              </p>
3109
   * @param int    $flags         [optional] <p>
3110
   *                              A bitmask of one or more of the following flags, which specify how to handle quotes,
3111
   *                              invalid code unit sequences and the used document type. The default is
3112
   *                              ENT_COMPAT | ENT_HTML401.
3113
   *                              <table>
3114
   *                              Available <i>flags</i> constants
3115 1
   *                              <tr valign="top">
3116
   *                              <td>Constant Name</td>
3117 1
   *                              <td>Description</td>
3118
   *                              </tr>
3119
   *                              <tr valign="top">
3120
   *                              <td><b>ENT_COMPAT</b></td>
3121
   *                              <td>Will convert double-quotes and leave single-quotes alone.</td>
3122
   *                              </tr>
3123
   *                              <tr valign="top">
3124
   *                              <td><b>ENT_QUOTES</b></td>
3125
   *                              <td>Will convert both double and single quotes.</td>
3126
   *                              </tr>
3127 1
   *                              <tr valign="top">
3128
   *                              <td><b>ENT_NOQUOTES</b></td>
3129 1
   *                              <td>Will leave both double and single quotes unconverted.</td>
3130
   *                              </tr>
3131
   *                              <tr valign="top">
3132
   *                              <td><b>ENT_IGNORE</b></td>
3133
   *                              <td>
3134
   *                              Silently discard invalid code unit sequences instead of returning
3135
   *                              an empty string. Using this flag is discouraged as it
3136
   *                              may have security implications.
3137
   *                              </td>
3138
   *                              </tr>
3139
   *                              <tr valign="top">
3140
   *                              <td><b>ENT_SUBSTITUTE</b></td>
3141
   *                              <td>
3142
   *                              Replace invalid code unit sequences with a Unicode Replacement Character
3143
   *                              U+FFFD (UTF-8) or &#38;#38;#FFFD; (otherwise) instead of returning an empty string.
3144
   *                              </td>
3145
   *                              </tr>
3146
   *                              <tr valign="top">
3147
   *                              <td><b>ENT_DISALLOWED</b></td>
3148
   *                              <td>
3149
   *                              Replace invalid code points for the given document type with a
3150
   *                              Unicode Replacement Character U+FFFD (UTF-8) or &#38;#38;#FFFD;
3151
   *                              (otherwise) instead of leaving them as is. This may be useful, for
3152
   *                              instance, to ensure the well-formedness of XML documents with
3153
   *                              embedded external content.
3154
   *                              </td>
3155
   *                              </tr>
3156
   *                              <tr valign="top">
3157
   *                              <td><b>ENT_HTML401</b></td>
3158
   *                              <td>
3159
   *                              Handle code as HTML 4.01.
3160
   *                              </td>
3161
   *                              </tr>
3162
   *                              <tr valign="top">
3163
   *                              <td><b>ENT_XML1</b></td>
3164
   *                              <td>
3165
   *                              Handle code as XML 1.
3166
   *                              </td>
3167
   *                              </tr>
3168
   *                              <tr valign="top">
3169
   *                              <td><b>ENT_XHTML</b></td>
3170
   *                              <td>
3171
   *                              Handle code as XHTML.
3172
   *                              </td>
3173
   *                              </tr>
3174
   *                              <tr valign="top">
3175
   *                              <td><b>ENT_HTML5</b></td>
3176
   *                              <td>
3177
   *                              Handle code as HTML 5.
3178
   *                              </td>
3179 16
   *                              </tr>
3180
   *                              </table>
3181 16
   *                              </p>
3182
   * @param string $encoding      [optional] <p>
3183
   *                              Defines encoding used in conversion.
3184
   *                              </p>
3185
   *                              <p>
3186
   *                              For the purposes of this function, the encodings
3187
   *                              ISO-8859-1, ISO-8859-15,
3188
   *                              UTF-8, cp866,
3189
   *                              cp1251, cp1252, and
3190
   *                              KOI8-R are effectively equivalent, provided the
3191
   *                              <i>string</i> itself is valid for the encoding, as
3192 4
   *                              the characters affected by <b>htmlspecialchars</b> occupy
3193
   *                              the same positions in all of these encodings.
3194 4
   *                              </p>
3195
   * @param bool   $double_encode [optional] <p>
3196
   *                              When <i>double_encode</i> is turned off PHP will not
3197
   *                              encode existing html entities, the default is to convert everything.
3198
   *                              </p>
3199
   *
3200
   * @return string The converted string.
3201
   * </p>
3202
   * <p>
3203
   * If the input <i>string</i> contains an invalid code unit
3204 1
   * sequence within the given <i>encoding</i> an empty string
3205
   * will be returned, unless either the <b>ENT_IGNORE</b> or
3206 1
   * <b>ENT_SUBSTITUTE</b> flags are set.
3207
   */
3208 1
  public static function htmlspecialchars($str, $flags = ENT_COMPAT, $encoding = 'UTF-8', $double_encode = true)
3209 1
  {
3210
    $encoding = self::normalizeEncoding($encoding);
3211
3212 1
    return htmlspecialchars($str, $flags, $encoding, $double_encode);
3213 1
  }
3214
3215 1
  /**
3216
   * checks whether iconv is available on the server
3217
   *
3218
   * @return   bool True if available, False otherwise
3219
   */
3220
  public static function iconv_loaded()
3221
  {
3222
    return extension_loaded('iconv') ? true : false;
3223
  }
3224
3225
  /**
3226 4
   * Converts Integer to hexadecimal U+xxxx code point representation.
3227
   *
3228
   * INFO: opposite to UTF8::hex_to_int()
3229 4
   *
3230
   * @param    int    $int The integer to be converted to hexadecimal code point.
3231
   * @param    string $pfix
3232 4
   *
3233
   * @return   string The code point, or empty string on failure.
3234 4
   */
3235 4
  public static function int_to_hex($int, $pfix = 'U+')
3236 4
  {
3237 4
    if (ctype_digit((string)$int)) {
3238 3
      $hex = dechex((int)$int);
3239
3240 4
      $hex = (strlen($hex) < 4 ? substr('0000' . $hex, -4) : $hex);
3241
3242
      return $pfix . $hex;
3243
    }
3244
3245
    return '';
3246
  }
3247
3248
  /**
3249
   * checks whether intl is available on the server
3250
   *
3251
   * @return   bool True if available, False otherwise
3252
   */
3253
  public static function intl_loaded()
3254
  {
3255
    return extension_loaded('intl') ? true : false;
3256
  }
3257
3258
  /**
3259
   * checks whether intl-char is available on the server
3260
   *
3261
   * @return   bool True if available, False otherwise
3262
   */
3263
  public static function intlChar_loaded()
3264
  {
3265
    return Bootup::is_php('7.0') === true and class_exists('IntlChar');
0 ignored issues
show
Comprehensibility Best Practice introduced by
Using logical operators such as and instead of && is generally not recommended.

PHP has two types of connecting operators (logical operators, and boolean operators):

  Logical Operators Boolean Operator
AND - meaning and &&
OR - meaning or ||

The difference between these is the order in which they are executed. In most cases, you would want to use a boolean operator like &&, or ||.

Let’s take a look at a few examples:

// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);

Logical Operators are used for Control-Flow

One case where you explicitly want to use logical operators is for control-flow such as this:

$x === 5
    or die('$x must be 5.');

// Instead of
if ($x !== 5) {
    die('$x must be 5.');
}

Since die introduces problems of its own, f.e. it makes our code hardly testable, and prevents any kind of more sophisticated error handling; you probably do not want to use this in real-world code. Unfortunately, logical operators cannot be combined with throw at this point:

// The following is currently a parse error.
$x === 5
    or throw new RuntimeException('$x must be 5.');

These limitations lead to logical operators rarely being of use in current PHP code.

Loading history...
3266
  }
3267
3268
  /**
3269
   * alias for "UTF8::is_ascii()"
3270
   *
3271
   * @param string $str
3272
   *
3273 2
   * @return boolean
3274
   */
3275 2
  public static function isAscii($str)
3276
  {
3277
    return self::is_ascii($str);
3278
  }
3279
3280
  /**
3281
   * alias for "UTF8::is_base64()"
3282
   *
3283
   * @param string $str
3284
   *
3285 2
   * @return bool
3286
   */
3287 2
  public static function isBase64($str)
3288 2
  {
3289
    return self::is_base64($str);
3290 2
  }
3291 2
3292 2
  /**
3293 2
   * alias for "UTF8::is_binary()"
3294 2
   *
3295 2
   * @param string $str
3296 2
   *
3297 2
   * @return bool
3298 2
   */
3299 1
  public static function isBinary($str)
3300 1
  {
3301 2
    return self::is_binary($str);
3302 2
  }
3303 2
3304
  /**
3305 2
   * alias for "UTF8::is_bom()"
3306 2
   *
3307 2
   * @param string $utf8_chr
3308 2
   *
3309 2
   * @return boolean
3310 2
   */
3311 2
  public static function isBom($utf8_chr)
3312 2
  {
3313 2
    return self::is_bom($utf8_chr);
3314 1
  }
3315 1
3316 2
  /**
3317 2
   * alias for "UTF8::is_json()"
3318 2
   *
3319
   * @param string $str
3320 2
   *
3321 1
   * @return bool
3322 1
   */
3323
  public static function isJson($str)
3324 1
  {
3325
    return self::is_json($str);
3326
  }
3327
3328 2
  /**
3329
   * alias for "UTF8::is_html()"
3330 2
   *
3331
   * @param string $str
3332
   *
3333
   * @return boolean
3334
   */
3335
  public static function isHtml($str)
3336
  {
3337
    return self::is_html($str);
3338
  }
3339
3340 2
  /**
3341
   * alias for "UTF8::is_utf8()"
3342 2
   *
3343 2
   * @param string $str
3344
   * @param  bool  $strict
3345 2
   *
3346 2
   * @return bool
3347 2
   */
3348 2
  public static function isUtf8($str, $strict = false)
3349 2
  {
3350 2
    return self::is_utf8($str, $strict);
3351 2
  }
3352 2
3353 2
  /**
3354
   * alias for "UTF8::is_utf16()"
3355
   *
3356 2
   * @param string $str
3357 2
   *
3358 2
   * @return int|false false if is't not UTF16, 1 for UTF-16LE, 2 for UTF-16BE.
3359
   */
3360 2
  public static function isUtf16($str)
3361 2
  {
3362 2
    return self::is_utf16($str);
3363 1
  }
3364 1
3365 1
  /**
3366 1
   * alias for "UTF8::is_utf32()"
3367 1
   *
3368 1
   * @param string $str
3369
   *
3370
   * @return int|false false if is't not UTF16, 1 for UTF-32LE, 2 for UTF-32BE.
3371 1
   */
3372 1
  public static function isUtf32($str)
3373 1
  {
3374
    return self::is_utf32($str);
3375 2
  }
3376
3377
  /**
3378
   * Checks if a string is 7 bit ASCII.
3379
   *
3380
   * @param    string $str The string to check.
3381
   *
3382
   * @return   bool <strong>true</strong> if it is ASCII<br />
3383 2
   *                <strong>false</strong> otherwise
3384
   */
3385 2
  public static function is_ascii($str)
3386
  {
3387
    return (bool)!preg_match('/[\x80-\xFF]/', $str);
3388
  }
3389
3390
  /**
3391
   * Returns true if the string is base64 encoded, false otherwise.
3392
   *
3393
   * @param string $str
3394
   *
3395
   * @return bool Whether or not $str is base64 encoded
3396
   */
3397 34
  public static function is_base64($str)
3398
  {
3399 34
    $str = (string)$str;
3400
3401 34
    if (!isset($str[0])) {
3402 3
      return false;
3403
    }
3404
3405 32
    if (base64_encode(base64_decode($str, true)) === $str) {
3406
      return true;
3407
    } else {
3408
      return false;
3409
    }
3410
  }
3411
3412
  /**
3413
   * Check if the input is binary... (is look like a hack).
3414
   *
3415 32
   * @param mixed $input
3416
   *
3417 32
   * @return bool
3418 32
   */
3419 32
  public static function is_binary($input)
3420
  {
3421
3422 32
    $testLength = strlen($input);
3423 32
3424 32
    if (
3425
        preg_match('~^[01]+$~', $input)
3426
        ||
3427 32
        substr_count($input, "\x00") > 0
3428
        ||
3429 30
        ($testLength ? substr_count($input, '^ -~') / $testLength > 0.3 : 1 === 0)
3430 32
    ) {
3431
      return true;
3432 28
    } else {
3433 28
      return false;
3434 28
    }
3435 28
  }
3436 30
3437
  /**
3438 13
   * Check if the file is binary.
3439 13
   *
3440 13
   * @param string $file
3441 13
   *
3442 23
   * @return boolean
3443
   */
3444 6
  public static function is_binary_file($file)
3445 6
  {
3446 6
    try {
3447 6
      $fp = fopen($file, 'r');
3448 12
      $block = fread($fp, 512);
3449
      fclose($fp);
3450
    } catch (\Exception $e) {
3451
      $block = '';
3452
    }
3453
3454
    return self::is_binary($block);
3455
  }
3456
3457 3
  /**
3458 3
   * Checks if the given string is equal to any "Byte Order Mark".
3459 3
   *
3460 3
   * WARNING: Use "UTF8::string_has_bom()" if you will check BOM in a string.
3461 7
   *
3462
   * @param    string $str The input string.
3463 3
   *
3464 3
   * @return   bool True if the $utf8_chr is Byte Order Mark, False otherwise.
3465 3
   */
3466 3
  public static function is_bom($str)
3467 3
  {
3468
    foreach (self::$bom as $bomString => $bomByteLength) {
3469
      if ($str === $bomString) {
3470
        return true;
3471 3
      }
3472
    }
3473 32
3474
    return false;
3475
  }
3476 30
3477
  /**
3478 28
   * Try to check if "$str" is an json-string.
3479 28
   *
3480 28
   * @param string $str
3481 28
   *
3482
   * @return bool
3483
   */
3484
  public static function is_json($str)
3485
  {
3486 28
    $str = (string)$str;
3487
3488
    if (!isset($str[0])) {
3489
      return false;
3490
    }
3491
3492 28
    if (
3493 28
        is_object(self::json_decode($str))
3494 28
        &&
3495 28
        json_last_error() === JSON_ERROR_NONE
3496
    ) {
3497 28
      return true;
3498
    } else {
3499 28
      return false;
3500 28
    }
3501 5
  }
3502
3503
  /**
3504 28
   * Check if the string contains any html-tags <lall>.
3505 28
   *
3506 28
   * @param string $str
3507 28
   *
3508 28
   * @return boolean
3509
   */
3510
  public static function is_html($str)
3511
  {
3512
    $str = (string)$str;
3513 13
3514
    if (!isset($str[0])) {
3515
      return false;
3516 32
    }
3517
3518 14
    // init
3519
    $matches = array();
3520
3521
    preg_match("/<\/?\w+((\s+\w+(\s*=\s*(?:\".*?\"|'.*?'|[^'\">\s]+))?)+\s*|\s*)\/?>/", $str, $matches);
3522
3523
    if (count($matches) == 0) {
3524
      return false;
3525
    } else {
3526
      return true;
3527
    }
3528
  }
3529
3530
  /**
3531
   * Check if the string is UTF-16.
3532
   *
3533
   * @param string $str
3534
   *
3535
   * @return int|false false if is't not UTF-16, 1 for UTF-16LE, 2 for UTF-16BE.
3536
   */
3537 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...
3538
  {
3539
    $str = self::remove_bom($str);
3540
3541
    if (self::is_binary($str)) {
3542
      self::checkForSupport();
3543
3544
      $maybeUTF16LE = 0;
3545
      $test = \mb_convert_encoding($str, 'UTF-8', 'UTF-16LE');
3546
      if ($test) {
3547
        $test2 = \mb_convert_encoding($test, 'UTF-16LE', 'UTF-8');
3548
        $test3 = \mb_convert_encoding($test2, 'UTF-8', 'UTF-16LE');
3549
        if ($test3 === $test) {
3550
          $strChars = self::count_chars($str, true);
3551
          foreach (self::count_chars($test3, true) as $test3char => $test3charEmpty) {
3552
            if (in_array($test3char, $strChars, true) === true) {
3553
              $maybeUTF16LE++;
3554
            }
3555
          }
3556
        }
3557
      }
3558 2
3559
      $maybeUTF16BE = 0;
3560 2
      $test = \mb_convert_encoding($str, 'UTF-8', 'UTF-16BE');
3561
      if ($test) {
3562 2
        $test2 = \mb_convert_encoding($test, 'UTF-16BE', 'UTF-8');
3563 2
        $test3 = \mb_convert_encoding($test2, 'UTF-8', 'UTF-16BE');
3564 2
        if ($test3 === $test) {
3565
          $strChars = self::count_chars($str, true);
3566
          foreach (self::count_chars($test3, true) as $test3char => $test3charEmpty) {
3567
            if (in_array($test3char, $strChars, true) === true) {
3568 2
              $maybeUTF16BE++;
3569
            }
3570
          }
3571
        }
3572
      }
3573
3574
      if ($maybeUTF16BE !== $maybeUTF16LE) {
3575
        if ($maybeUTF16LE > $maybeUTF16BE) {
3576
          return 1;
3577
        } else {
3578
          return 2;
3579
        }
3580
      }
3581
3582
    }
3583
3584
    return false;
3585
  }
3586
3587
  /**
3588
   * Check if the string is UTF-32.
3589
   *
3590
   * @param string $str
3591
   *
3592
   * @return int|false false if is't not UTF-16, 1 for UTF-32LE, 2 for UTF-32BE.
3593
   */
3594 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...
3595
  {
3596
    $str = self::remove_bom($str);
3597
3598
    if (self::is_binary($str)) {
3599
      self::checkForSupport();
3600
3601
      $maybeUTF32LE = 0;
3602
      $test = \mb_convert_encoding($str, 'UTF-8', 'UTF-32LE');
3603
      if ($test) {
3604
        $test2 = \mb_convert_encoding($test, 'UTF-32LE', 'UTF-8');
3605
        $test3 = \mb_convert_encoding($test2, 'UTF-8', 'UTF-32LE');
3606
        if ($test3 === $test) {
3607 1
          $strChars = self::count_chars($str, true);
3608
          foreach (self::count_chars($test3, true) as $test3char => $test3charEmpty) {
3609 1
            if (in_array($test3char, $strChars, true) === true) {
3610
              $maybeUTF32LE++;
3611 1
            }
3612
          }
3613
        }
3614 1
      }
3615
3616
      $maybeUTF32BE = 0;
3617 1
      $test = \mb_convert_encoding($str, 'UTF-8', 'UTF-32BE');
3618
      if ($test) {
3619
        $test2 = \mb_convert_encoding($test, 'UTF-32BE', 'UTF-8');
3620
        $test3 = \mb_convert_encoding($test2, 'UTF-8', 'UTF-32BE');
3621
        if ($test3 === $test) {
3622
          $strChars = self::count_chars($str, true);
3623
          foreach (self::count_chars($test3, true) as $test3char => $test3charEmpty) {
3624
            if (in_array($test3char, $strChars, true) === true) {
3625
              $maybeUTF32BE++;
3626
            }
3627 6
          }
3628
        }
3629 6
      }
3630
3631
      if ($maybeUTF32BE !== $maybeUTF32LE) {
3632
        if ($maybeUTF32LE > $maybeUTF32BE) {
3633
          return 1;
3634
        } else {
3635
          return 2;
3636
        }
3637
      }
3638
3639
    }
3640
3641
    return false;
3642 24
  }
3643
3644 24
  /**
3645
   * Checks whether the passed string contains only byte sequences that appear valid UTF-8 characters.
3646 24
   *
3647 2
   * @see    http://hsivonen.iki.fi/php-utf8/
3648
   *
3649
   * @param  string $str    The string to be checked.
3650 23
   * @param  bool   $strict Check also if the string is not UTF-16 or UTF-32.
3651
   *
3652 23
   * @return bool
3653
   */
3654
  public static function is_utf8($str, $strict = false)
3655
  {
3656
    $str = (string)$str;
3657
3658
    if (!isset($str[0])) {
3659
      return true;
3660
    }
3661
3662 1
    if ($strict === true) {
3663
      if (self::is_utf16($str) !== false) {
3664 1
        return false;
3665
      }
3666
3667
      if (self::is_utf32($str) !== false) {
3668 1
        return false;
3669
      }
3670
    }
3671
3672
    if (self::pcre_utf8_support() !== true) {
3673
3674
      // If even just the first character can be matched, when the /u
3675
      // modifier is used, then it's valid UTF-8. If the UTF-8 is somehow
3676
      // invalid, nothing at all will match, even if the string contains
3677
      // some valid sequences
3678
      return (preg_match('/^.{1}/us', $str, $ar) === 1);
3679 1
3680
    } else {
3681 1
3682 1
      $mState = 0; // cached expected number of octets after the current octet
3683 1
      // until the beginning of the next UTF8 character sequence
3684
      $mUcs4 = 0; // cached Unicode character
3685 1
      $mBytes = 1; // cached expected number of octets in the current sequence
3686
      $len = strlen($str);
3687
3688
      /** @noinspection ForeachInvariantsInspection */
3689
      for ($i = 0; $i < $len; $i++) {
3690
        $in = ord($str[$i]);
3691
        if ($mState === 0) {
3692
          // When mState is zero we expect either a US-ASCII character or a
3693
          // multi-octet sequence.
3694 2
          if (0 === (0x80 & $in)) {
3695
            // US-ASCII, pass straight through.
3696 2
            $mBytes = 1;
3697 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...
3698 2
            // First octet of 2 octet sequence.
3699 2
            $mUcs4 = $in;
3700 2
            $mUcs4 = ($mUcs4 & 0x1F) << 6;
3701
            $mState = 1;
3702 2
            $mBytes = 2;
3703
          } elseif (0xE0 === (0xF0 & $in)) {
3704
            // First octet of 3 octet sequence.
3705
            $mUcs4 = $in;
3706
            $mUcs4 = ($mUcs4 & 0x0F) << 12;
3707
            $mState = 2;
3708
            $mBytes = 3;
3709 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...
3710
            // First octet of 4 octet sequence.
3711
            $mUcs4 = $in;
3712 1
            $mUcs4 = ($mUcs4 & 0x07) << 18;
3713
            $mState = 3;
3714 1
            $mBytes = 4;
3715
          } elseif (0xF8 === (0xFC & $in)) {
3716
            /* First octet of 5 octet sequence.
3717
            *
3718 1
            * This is illegal because the encoded codepoint must be either
3719
            * (a) not the shortest form or
3720
            * (b) outside the Unicode range of 0-0x10FFFF.
3721
            * Rather than trying to resynchronize, we will carry on until the end
3722
            * of the sequence and let the later error handling code catch it.
3723
            */
3724
            $mUcs4 = $in;
3725
            $mUcs4 = ($mUcs4 & 0x03) << 24;
3726
            $mState = 4;
3727
            $mBytes = 5;
3728 13 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...
3729
            // First octet of 6 octet sequence, see comments for 5 octet sequence.
3730 13
            $mUcs4 = $in;
3731
            $mUcs4 = ($mUcs4 & 1) << 30;
3732 13
            $mState = 5;
3733
            $mBytes = 6;
3734
          } else {
3735 13
            /* Current octet is neither in the US-ASCII range nor a legal first
3736 13
             * octet of a multi-octet sequence.
3737 13
             */
3738 13
            return false;
3739 13
          }
3740 13
        } else {
3741 13
          // When mState is non-zero, we expect a continuation of the multi-octet
3742 13
          // sequence
3743 13
          if (0x80 === (0xC0 & $in)) {
3744 13
            // Legal continuation.
3745 13
            $shift = ($mState - 1) * 6;
3746 13
            $tmp = $in;
3747 13
            $tmp = ($tmp & 0x0000003F) << $shift;
3748 13
            $mUcs4 |= $tmp;
3749
            /**
3750 13
             * End of the multi-octet sequence. mUcs4 now contains the final
3751 2
             * Unicode code point to be output
3752
             */
3753
            if (0 === --$mState) {
3754 13
              /*
3755
              * Check for illegal sequences and code points.
3756
              */
3757
              // From Unicode 3.1, non-shortest form is illegal
3758
              if (
3759
                  (2 === $mBytes && $mUcs4 < 0x0080) ||
3760
                  (3 === $mBytes && $mUcs4 < 0x0800) ||
3761
                  (4 === $mBytes && $mUcs4 < 0x10000) ||
3762
                  (4 < $mBytes) ||
3763
                  // From Unicode 3.2, surrogate characters are illegal.
3764 2
                  (($mUcs4 & 0xFFFFF800) === 0xD800) ||
3765
                  // Code points outside the Unicode range are illegal.
3766 2
                  ($mUcs4 > 0x10FFFF)
3767 2
              ) {
3768
                return false;
3769 2
              }
3770 1
              // initialize UTF8 cache
3771 1
              $mState = 0;
3772 1
              $mUcs4 = 0;
3773
              $mBytes = 1;
3774 2
            }
3775
          } else {
3776
            /**
3777
             *((0xC0 & (*in) != 0x80) && (mState != 0))
3778
             * Incomplete multi-octet sequence.
3779
             */
3780
            return false;
3781
          }
3782
        }
3783
      }
3784
3785
      return true;
3786 8
    }
3787
  }
3788 8
3789 8
  /**
3790
   * (PHP 5 &gt;= 5.2.0, PECL json &gt;= 1.2.0)<br/>
3791 8
   * Decodes a JSON string
3792
   *
3793 8
   * @link http://php.net/manual/en/function.json-decode.php
3794
   *
3795 2
   * @param string $json    <p>
3796
   *                        The <i>json</i> string being decoded.
3797 2
   *                        </p>
3798
   *                        <p>
3799 1
   *                        This function only works with UTF-8 encoded strings.
3800 1
   *                        </p>
3801
   *                        <p>PHP implements a superset of
3802 2
   *                        JSON - it will also encode and decode scalar types and <b>NULL</b>. The JSON standard
3803 2
   *                        only supports these values when they are nested inside an array or an object.
3804
   *                        </p>
3805 8
   * @param bool   $assoc   [optional] <p>
3806 8
   *                        When <b>TRUE</b>, returned objects will be converted into
3807 1
   *                        associative arrays.
3808 1
   *                        </p>
3809
   * @param int    $depth   [optional] <p>
3810 8
   *                        User specified recursion depth.
3811 8
   *                        </p>
3812
   * @param int    $options [optional] <p>
3813 8
   *                        Bitmask of JSON decode options. Currently only
3814
   *                        <b>JSON_BIGINT_AS_STRING</b>
3815
   *                        is supported (default is to cast large integers as floats)
3816
   *                        </p>
3817
   *
3818
   * @return mixed the value encoded in <i>json</i> in appropriate
3819
   * PHP type. Values true, false and
3820
   * null (case-insensitive) are returned as <b>TRUE</b>, <b>FALSE</b>
3821
   * and <b>NULL</b> respectively. <b>NULL</b> is returned if the
3822
   * <i>json</i> cannot be decoded or if the encoded
3823
   * data is deeper than the recursion limit.
3824
   */
3825
  public static function json_decode($json, $assoc = false, $depth = 512, $options = 0)
3826 1
  {
3827
    $json = self::filter($json);
3828 1
3829 1
    if (Bootup::is_php('5.4') === true) {
3830
      $json = json_decode($json, $assoc, $depth, $options);
3831
    } else {
3832
      $json = json_decode($json, $assoc, $depth);
3833
    }
3834
3835
    return $json;
3836
  }
3837
3838
  /**
3839
   * (PHP 5 &gt;= 5.2.0, PECL json &gt;= 1.2.0)<br/>
3840
   * Returns the JSON representation of a value.
3841
   *
3842 1
   * @link http://php.net/manual/en/function.json-encode.php
3843
   *
3844 1
   * @param mixed $value   <p>
3845
   *                       The <i>value</i> being encoded. Can be any type except
3846
   *                       a resource.
3847
   *                       </p>
3848
   *                       <p>
3849
   *                       All string data must be UTF-8 encoded.
3850
   *                       </p>
3851
   *                       <p>PHP implements a superset of
3852
   *                       JSON - it will also encode and decode scalar types and <b>NULL</b>. The JSON standard
3853
   *                       only supports these values when they are nested inside an array or an object.
3854
   *                       </p>
3855 15
   * @param int   $options [optional] <p>
3856
   *                       Bitmask consisting of <b>JSON_HEX_QUOT</b>,
3857 15
   *                       <b>JSON_HEX_TAG</b>,
3858 2
   *                       <b>JSON_HEX_AMP</b>,
3859
   *                       <b>JSON_HEX_APOS</b>,
3860
   *                       <b>JSON_NUMERIC_CHECK</b>,
3861 14
   *                       <b>JSON_PRETTY_PRINT</b>,
3862 14
   *                       <b>JSON_UNESCAPED_SLASHES</b>,
3863
   *                       <b>JSON_FORCE_OBJECT</b>,
3864 14
   *                       <b>JSON_UNESCAPED_UNICODE</b>. The behaviour of these
3865 2
   *                       constants is described on
3866
   *                       the JSON constants page.
3867
   *                       </p>
3868 13
   * @param int   $depth   [optional] <p>
3869 7
   *                       Set the maximum depth. Must be greater than zero.
3870
   *                       </p>
3871
   *
3872 12
   * @return string a JSON encoded string on success or <b>FALSE</b> on failure.
3873 8
   */
3874
  public static function json_encode($value, $options = 0, $depth = 512)
3875
  {
3876 10
    $value = self::filter($value);
3877
3878
    if (Bootup::is_php('5.5')) {
3879
      $json = json_encode($value, $options, $depth);
3880
    } else {
3881
      $json = json_encode($value, $options);
3882
    }
3883
3884
    return $json;
3885
  }
3886
3887
  /**
3888
   * Makes string's first char lowercase.
3889
   *
3890
   * @param    string $str The input string
3891
   *
3892
   * @return   string The resulting string
3893
   */
3894
  public static function lcfirst($str)
3895
  {
3896
    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...
3897 1
  }
3898
3899
  /**
3900 1
   * Strip whitespace or other characters from beginning of a UTF-8 string.
3901
   *
3902 1
   * @param  string $str   The string to be trimmed
3903
   * @param  string $chars Optional characters to be stripped
3904 1
   *
3905 1
   * @return string The string with unwanted characters stripped from the left
3906
   */
3907 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...
3908
  {
3909
    $str = (string)$str;
3910
3911
    if (!isset($str[0])) {
3912 33
      return '';
3913
    }
3914
3915 33
    // Info: http://nadeausoftware.com/articles/2007/9/php_tip_how_strip_punctuation_characters_web_page#Unicodecharactercategories
3916
    if ($chars === INF || !$chars) {
3917
      return preg_replace('/^[\pZ\pC]+/u', '', $str);
3918
    }
3919
3920
    $chars = INF === $chars ? '\s' : self::rxClass($chars);
3921
3922
    return preg_replace("/^{$chars}+/u", '', $str);
3923
  }
3924
3925
  /**
3926 1
   * Returns the UTF-8 character with the maximum code point in the given data.
3927
   *
3928 1
   * @param    mixed $arg A UTF-8 encoded string or an array of such strings.
3929 1
   *
3930
   * @return   string The character with the highest code point than others.
3931
   */
3932 1 View Code Duplication
  public static function max($arg)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

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

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

Loading history...
3933
  {
3934 1
    if (is_array($arg)) {
3935
      $arg = implode($arg);
3936
    }
3937 1
3938
    return self::chr(max(self::codepoints($arg)));
3939
  }
3940 1
3941
  /**
3942
   * Calculates and returns the maximum number of bytes taken by any
3943
   * UTF-8 encoded character in the given string.
3944 1
   *
3945
   * @param    string $str The original Unicode string.
3946 1
   *
3947
   * @return   int An array of byte lengths of each character.
3948
   */
3949 1
  public static function max_chr_width($str)
3950
  {
3951
    $bytes = self::chr_size_list($str);
3952 1
    if (count($bytes) > 0) {
3953
      return (int)max($bytes);
3954
    } else {
3955
      return 0;
3956 1
    }
3957
  }
3958 1
3959 1
  /**
3960 1
   * checks whether mbstring is available on the server
3961 1
   *
3962 1
   * @return   bool True if available, False otherwise
3963
   */
3964
  public static function mbstring_loaded()
3965
  {
3966
    $return = extension_loaded('mbstring');
3967
3968
    if ($return === true) {
3969
      \mb_internal_encoding('UTF-8');
3970
    }
3971
3972
    return $return;
3973
  }
3974
3975 7
  /**
3976
   * Returns the UTF-8 character with the minimum code point in the given data.
3977 7
   *
3978
   * @param    mixed $arg A UTF-8 encoded string or an array of such strings.
3979
   *
3980 7
   * @return   string The character with the lowest code point than others.
3981 2
   */
3982 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...
3983 7
  {
3984
    if (is_array($arg)) {
3985 7
      $arg = implode($arg);
3986
    }
3987
3988 3
    return self::chr(min(self::codepoints($arg)));
3989 1
  }
3990 1
3991
  /**
3992
   * Normalize the encoding-name input.
3993
   *
3994 3
   * @param string $encoding e.g.: ISO, UTF8, WINDOWS-1251 etc.
3995 1
   *
3996 1
   * @return string e.g.: ISO-8859-1, UTF-8, WINDOWS-1251 etc.
3997 3
   */
3998
  public static function normalizeEncoding($encoding)
3999 7
  {
4000
    static $staticNormalizeEncodingCache = array();
4001
4002 3
    if (!$encoding) {
4003 1
      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::normalizeEncoding 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...
4004 1
    }
4005
4006
    if ('UTF-8' === $encoding) {
4007
      return $encoding;
4008 3
    }
4009 1
4010 1
    if (in_array($encoding, self::$iconvEncoding, true)) {
4011 3
      return $encoding;
4012
    }
4013 7
4014
    if (isset($staticNormalizeEncodingCache[$encoding])) {
4015
      return $staticNormalizeEncodingCache[$encoding];
4016
    }
4017
4018
    $encodingOrig = $encoding;
4019
    $encoding = strtoupper($encoding);
4020
    $encodingUpperHelper = preg_replace('/[^a-zA-Z0-9\s]/', '', $encoding);
4021
4022
    $equivalences = array(
4023
        'ISO88591'    => 'ISO-8859-1',
4024 1
        'ISO8859'     => 'ISO-8859-1',
4025
        'ISO'         => 'ISO-8859-1',
4026 1
        'LATIN1'      => 'ISO-8859-1',
4027 1
        'LATIN'       => 'ISO-8859-1',
4028 1
        'UTF16'       => 'UTF-16',
4029
        'UTF32'       => 'UTF-32',
4030 1
        'UTF8'        => 'UTF-8',
4031 1
        'UTF'         => 'UTF-8',
4032 1
        'UTF7'        => 'UTF-7',
4033 1
        'WIN1252'     => 'ISO-8859-1',
4034 1
        'WINDOWS1252' => 'ISO-8859-1',
4035
        '8BIT'        => 'CP850',
4036 1
        'BINARY'      => 'CP850',
4037
    );
4038
4039
    if (!empty($equivalences[$encodingUpperHelper])) {
4040
      $encoding = $equivalences[$encodingUpperHelper];
4041
    }
4042
4043
    $staticNormalizeEncodingCache[$encodingOrig] = $encoding;
4044
4045
    return $encoding;
4046
  }
4047
4048
  /**
4049
   * Normalize MS Word special characters.
4050
   *
4051
   * @param string $str The string to be normalized.
4052 36
   *
4053
   * @return string
4054
   */
4055 36
  public static function normalize_msword($str)
4056
  {
4057
    static $utf8MSWordKeys = null;
4058
    static $utf8MSWordValues = null;
4059 36
4060 36
    if ($utf8MSWordKeys === null) {
4061 36
      $utf8MSWordKeys = array_keys(self::$utf8MSWord);
4062 36
      $utf8MSWordValues = array_values(self::$utf8MSWord);
4063
    }
4064 36
4065
    return str_replace($utf8MSWordKeys, $utf8MSWordValues, $str);
4066
  }
4067 36
4068 36
  /**
4069
   * Normalize the whitespace.
4070 36
   *
4071
   * @param string $str                     The string to be normalized.
4072
   * @param bool   $keepNonBreakingSpace    Set to true, to keep non-breaking-spaces.
4073
   * @param bool   $keepBidiUnicodeControls Set to true, to keep non-printable (for the web) bidirectional text chars.
4074
   *
4075
   * @return string
4076
   */
4077
  public static function normalize_whitespace($str, $keepNonBreakingSpace = false, $keepBidiUnicodeControls = false)
4078
  {
4079
    static $whitespaces = array();
4080
    static $bidiUniCodeControls = null;
4081 36
4082
    $cacheKey = (int)$keepNonBreakingSpace;
4083 36
4084
    if (!isset($whitespaces[$cacheKey])) {
4085 36
4086 36
      $whitespaces[$cacheKey] = self::$whitespaceTable;
4087 36
4088
      if ($keepNonBreakingSpace === true) {
4089 36
        /** @noinspection OffsetOperationsInspection */
4090 36
        unset($whitespaces[$cacheKey]['NO-BREAK SPACE']);
4091 36
      }
4092
4093 36
      $whitespaces[$cacheKey] = array_values($whitespaces[$cacheKey]);
4094
    }
4095
4096
    if ($keepBidiUnicodeControls === false) {
4097
      if ($bidiUniCodeControls === null) {
4098
        $bidiUniCodeControls = array_values(self::$bidiUniCodeControlsTable);
4099
      }
4100
4101
      $str = str_replace($bidiUniCodeControls, '', $str);
4102
    }
4103
4104
    return str_replace($whitespaces[$cacheKey], ' ', $str);
4105
  }
4106 23
4107
  /**
4108 23
   * Format a number with grouped thousands.
4109
   *
4110 23
   * @param float  $number
4111 5
   * @param int    $decimals
4112
   * @param string $dec_point
4113
   * @param string $thousands_sep
4114 19
   *
4115
   * @return string
4116 19
   */
4117
  public static function number_format($number, $decimals = 0, $dec_point = '.', $thousands_sep = ',')
4118
  {
4119
    $thousands_sep = (string)$thousands_sep;
4120
    $dec_point = (string)$dec_point;
4121
4122
    if (
4123
        isset($thousands_sep[1], $dec_point[1])
4124
        &&
4125
        Bootup::is_php('5.4') === true
4126
    ) {
4127 40
      return str_replace(
4128
          array(
4129 40
              '.',
4130
              ',',
4131 40
          ),
4132
          array(
4133 40
              $dec_point,
4134 30
              $thousands_sep,
4135
          ),
4136
          number_format($number, $decimals, '.', ',')
4137 16
      );
4138
    }
4139 16
4140 15
    return number_format($number, $decimals, $dec_point, $thousands_sep);
4141
  }
4142 15
4143 14
  /**
4144 15
   * Calculates Unicode code point of the given UTF-8 encoded character.
4145 1
   *
4146 1
   * @param    string $s The character of which to calculate code point.
4147
   *
4148
   * @return   int Unicode code point of the given character,<br />
4149 16
   *           0 on invalid UTF-8 byte sequence.
4150
   */
4151 16
  public static function ord($s)
4152
  {
4153 16
    if (!$s && $s !== '0') {
4154 16
      return 0;
4155 16
    }
4156
4157
    // init
4158
    self::checkForSupport();
4159 16
4160
    if (self::$support['intlChar'] === true) {
4161 16
      $tmpReturn = \IntlChar::ord($s);
4162
      if ($tmpReturn) {
4163
        return $tmpReturn;
4164
      }
4165
    }
4166
4167
    $s = unpack('C*', substr($s, 0, 4));
4168
    $a = $s ? $s[1] : 0;
4169
4170
    if (0xF0 <= $a && isset($s[4])) {
4171
      return (($a - 0xF0) << 18) + (($s[2] - 0x80) << 12) + (($s[3] - 0x80) << 6) + $s[4] - 0x80;
4172
    }
4173
4174
    if (0xE0 <= $a && isset($s[3])) {
4175
      return (($a - 0xE0) << 12) + (($s[2] - 0x80) << 6) + $s[3] - 0x80;
4176
    }
4177
4178
    if (0xC0 <= $a && isset($s[2])) {
4179
      return (($a - 0xC0) << 6) + $s[2] - 0x80;
4180
    }
4181 2
4182
    return $a;
4183 2
  }
4184 1
4185
  /**
4186
   * Parses the string into variables.
4187 2
   *
4188
   * WARNING: This differs from parse_str() by returning the results
4189
   *    instead of placing them in the local scope!
4190
   *
4191
   * @link http://php.net/manual/en/function.parse-str.php
4192
   *
4193
   * @param string $str     <p>
4194
   *                        The input string.
4195
   *                        </p>
4196
   * @param array  $result  <p>
4197
   *                        If the second parameter arr is present,
4198
   *                        variables are stored in this variable as array elements instead.
4199 25
   *                        </p>
4200
   *
4201 25
   * @return void
4202
   */
4203 25
  public static function parse_str($str, &$result)
4204 5
  {
4205
    // init
4206
    self::checkForSupport();
4207
4208 24
    $str = self::filter($str);
4209 24
4210 24
    \mb_parse_str($str, $result);
4211
  }
4212 24
4213
  /**
4214 24
   * checks if \u modifier is available that enables Unicode support in PCRE.
4215
   *
4216
   * @return   bool True if support is available, false otherwise
4217
   */
4218 24
  public static function pcre_utf8_support()
4219 24
  {
4220 24
    /** @noinspection PhpUsageOfSilenceOperatorInspection */
4221 24
    return (bool)@preg_match('//u', '');
4222 24
  }
4223
4224 24
  /**
4225
   * Create an array containing a range of UTF-8 characters.
4226
   *
4227
   * @param    mixed $var1 Numeric or hexadecimal code points, or a UTF-8 character to start from.
4228
   * @param    mixed $var2 Numeric or hexadecimal code points, or a UTF-8 character to end at.
4229
   *
4230
   * @return   array
4231
   */
4232
  public static function range($var1, $var2)
4233
  {
4234
    if (!$var1 || !$var2) {
4235
      return array();
4236
    }
4237
4238 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...
4239
      $start = (int)$var1;
4240
    } elseif (ctype_xdigit($var1)) {
4241
      $start = (int)self::hex_to_int($var1);
4242
    } else {
4243
      $start = self::ord($var1);
4244
    }
4245
4246
    if (!$start) {
4247
      return array();
4248
    }
4249
4250 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...
4251
      $end = (int)$var2;
4252
    } elseif (ctype_xdigit($var2)) {
4253
      $end = (int)self::hex_to_int($var2);
4254
    } else {
4255
      $end = self::ord($var2);
4256 24
    }
4257 5
4258
    if (!$end) {
4259 5
      return array();
4260 5
    }
4261
4262 24
    return array_map(
4263
        array(
4264
            '\\voku\\helper\\UTF8',
4265
            'chr',
4266 24
        ),
4267
        range($start, $end)
4268
    );
4269
  }
4270
4271
  /**
4272
   * alias for "UTF8::removeBOM()"
4273
   *
4274
   * @param string $str
4275
   *
4276
   * @return string
4277 3
   */
4278
  public static function remove_bom($str)
4279
  {
4280
    return self::removeBOM($str);
4281
  }
4282
4283
  /**
4284 3
   * Remove the BOM from UTF-8 / UTF-16 / UTF-32 strings.
4285 2
   *
4286 1
   * @param string $str
4287 2
   *
4288 1
   * @return string
4289 2
   */
4290
  public static function removeBOM($str)
4291 2
  {
4292
    foreach (self::$bom as $bomString => $bomByteLength) {
4293
      if (0 === strpos($str, $bomString)) {
4294 2
        $str = substr($str, $bomByteLength);
4295
      }
4296
    }
4297
4298
    return $str;
4299
  }
4300 3
4301 1
  /**
4302
   * Removes duplicate occurrences of a string in another string.
4303
   *
4304
   * @param    string       $str  The base string
4305
   * @param    string|array $what String to search for in the base string
4306
   *
4307
   * @return   string The result string with removed duplicates
4308
   */
4309
  public static function remove_duplicates($str, $what = ' ')
4310 3
  {
4311 3
    if (is_string($what)) {
4312 3
      $what = array($what);
4313 3
    }
4314 3
4315 3
    if (is_array($what)) {
4316 3
      foreach ($what as $item) {
4317 3
        $str = preg_replace('/(' . preg_quote($item, '/') . ')+/', $item, $str);
4318
      }
4319
    }
4320 3
4321 3
    return $str;
4322 3
  }
4323 3
4324
  /**
4325
   * Remove Invisible Characters
4326
   *
4327
   * This prevents sandwiching null characters
4328
   * between ascii characters, like Java\0script.
4329
   *
4330
   * copy&past from https://github.com/bcit-ci/CodeIgniter/blob/develop/system/core/Common.php
4331
   *
4332
   * @param  string $str
4333
   * @param  bool   $url_encoded
4334
   * @param  string $replacement
4335
   *
4336
   * @return  string
4337
   */
4338
  public static function remove_invisible_characters($str, $url_encoded = true, $replacement = '')
4339
  {
4340
    // init
4341
    $non_displayables = array();
4342
4343
    // every control character except newline (dec 10),
4344
    // 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...
4345
    if ($url_encoded) {
4346
      $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...
4347
      $non_displayables[] = '/%1[0-9a-f]/'; // url encoded 16-31
4348
    }
4349
4350
    $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...
4351
4352
    do {
4353 13
      $str = preg_replace($non_displayables, $replacement, $str, -1, $count);
4354
    } while ($count !== 0);
4355 13
4356
    return $str;
4357
  }
4358 13
4359 13
  /**
4360 1
   * replace diamond question mark (�)
4361 1
   *
4362 12
   * @param string $str
4363
   * @param string $unknown
4364 13
   *
4365
   * @return string
4366 13
   */
4367 13
  public static function replace_diamond_question_mark($str, $unknown = '?')
4368
  {
4369 13
    return str_replace(
4370
        array(
4371
            "\xEF\xBF\xBD",
4372
            '�',
4373
        ),
4374
        array(
4375
            $unknown,
4376
            $unknown,
4377
        ),
4378
        $str
4379
    );
4380
  }
4381 1
4382
  /**
4383 1
   * Strip whitespace or other characters from end of a UTF-8 string.
4384
   *
4385
   * @param    string $str   The string to be trimmed
4386
   * @param    string $chars Optional characters to be stripped
4387 1
   *
4388
   * @return   string The string with unwanted characters stripped from the right
4389 1
   */
4390 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...
4391
  {
4392
    $str = (string)$str;
4393 1
4394 1
    if (!isset($str[0])) {
4395
      return '';
4396
    }
4397 1
4398 1
    // Info: http://nadeausoftware.com/articles/2007/9/php_tip_how_strip_punctuation_characters_web_page#Unicodecharactercategories
4399 1
    if ($chars === INF || !$chars) {
4400 1
      return preg_replace('/[\pZ\pC]+$/u', '', $str);
4401
    }
4402 1
4403
    $chars = INF === $chars ? '\s' : self::rxClass($chars);
4404
4405 1
    return preg_replace("/{$chars}+$/u", '', $str);
4406
  }
4407
4408 1
  /**
4409
   * rxClass
4410
   *
4411
   * @param string $s
4412
   * @param string $class
4413
   *
4414
   * @return string
4415
   */
4416
  protected static function rxClass($s, $class = '')
4417
  {
4418
    static $rxClassCache = array();
4419
4420
    $cacheKey = $s . $class;
4421 2
4422
    if (isset($rxClassCache[$cacheKey])) {
4423 2
      return $rxClassCache[$cacheKey];
4424
    }
4425 2
4426 2
    $class = array($class);
4427
4428 2
    /** @noinspection SuspiciousLoopInspection */
4429
    foreach (self::str_split($s) as $s) {
4430
      if ('-' === $s) {
4431 2
        $class[0] = '-' . $class[0];
4432 2
      } elseif (!isset($s[2])) {
4433 2
        $class[0] .= preg_quote($s, '/');
4434 2
      } elseif (1 === self::strlen($s)) {
4435 2
        $class[0] .= $s;
4436
      } else {
4437 2
        $class[] = $s;
4438 2
      }
4439 2
    }
4440 2
4441 2
    if ($class[0]) {
4442 2
      $class[0] = '[' . $class[0] . ']';
4443
    }
4444 2
4445 2
    if (1 === count($class)) {
4446 2
      $return = $class[0];
4447 2
    } else {
4448 2
      $return = '(?:' . implode('|', $class) . ')';
4449 2
    }
4450
4451 2
    $rxClassCache[$cacheKey] = $return;
4452
4453
    return $return;
4454 2
  }
4455
4456
  /**
4457
   * Echo native UTF8-Support libs, e.g. for debugging.
4458
   */
4459
  public static function showSupport()
4460
  {
4461
    foreach (self::$support as $utf8Support) {
4462
      echo $utf8Support . "\n<br>";
4463
    }
4464
  }
4465
4466
  /**
4467
   * Converts a UTF-8 character to HTML Numbered Entity like "&#123;".
4468
   *
4469
   * @param    string $char           The Unicode character to be encoded as numbered entity.
4470
   * @param    bool   $keepAsciiChars Keep ASCII chars.
4471
   *
4472
   * @return   string The HTML numbered entity.
4473
   */
4474
  public static function single_chr_html_encode($char, $keepAsciiChars = false)
4475 1
  {
4476
    if (!$char) {
4477 1
      return '';
4478
    }
4479 1
4480
    if (
4481
        $keepAsciiChars === true
4482
        &&
4483
        self::isAscii($char) === true
4484
    ) {
4485
      return $char;
4486
    }
4487
4488
    return '&#' . self::ord($char) . ';';
4489
  }
4490
4491
  /**
4492
   * Convert a string to an array of Unicode characters.
4493
   *
4494
   * @param    string  $str       The string to split into array.
4495
   * @param    int     $length    Max character length of each array element.
4496
   * @param    boolean $cleanUtf8 Clean non UTF-8 chars from the string.
4497
   *
4498
   * @return   array An array containing chunks of the string.
4499
   */
4500
  public static function split($str, $length = 1, $cleanUtf8 = false)
4501
  {
4502
    $str = (string)$str;
4503
4504
    if (!isset($str[0])) {
4505
      return array();
4506
    }
4507
4508
    // init
4509
    self::checkForSupport();
4510
    $str = (string)$str;
4511
    $ret = array();
4512 12
4513
    if (self::$support['pcre_utf8'] === true) {
4514 12
4515
      if ($cleanUtf8 === true) {
4516
        $str = self::clean($str);
4517
      }
4518
4519
      preg_match_all('/./us', $str, $retArray);
4520
      if (isset($retArray[0])) {
4521
        $ret = $retArray[0];
4522
      }
4523
      unset($retArray);
4524
4525
    } else {
4526
4527
      // fallback
4528
4529
      $len = strlen($str);
4530
4531
      /** @noinspection ForeachInvariantsInspection */
4532
      for ($i = 0; $i < $len; $i++) {
4533
        if (($str[$i] & "\x80") === "\x00") {
4534
          $ret[] = $str[$i];
4535
        } elseif ((($str[$i] & "\xE0") === "\xC0") && isset($str[$i + 1])) {
4536
          if (($str[$i + 1] & "\xC0") === "\x80") {
4537
            $ret[] = $str[$i] . $str[$i + 1];
4538
4539
            $i++;
4540
          }
4541 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...
4542 1
          if ((($str[$i + 1] & "\xC0") === "\x80") && (($str[$i + 2] & "\xC0") === "\x80")) {
4543
            $ret[] = $str[$i] . $str[$i + 1] . $str[$i + 2];
4544 1
4545
            $i += 2;
4546 1
          }
4547 1
        } elseif ((($str[$i] & "\xF8") === "\xF0") && isset($str[$i + 3])) {
4548 1 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...
4549
            $ret[] = $str[$i] . $str[$i + 1] . $str[$i + 2] . $str[$i + 3];
4550 1
4551 1
            $i += 3;
4552 1
          }
4553 1
        }
4554
      }
4555
    }
4556 1
4557
    if ($length > 1) {
4558
      $ret = array_chunk($ret, $length);
4559
4560
      $ret = array_map('implode', $ret);
4561
    }
4562
4563
    /** @noinspection OffsetOperationsInspection */
4564
    if (isset($ret[0]) && $ret[0] === '') {
4565
      return array();
4566
    }
4567 17
4568
    return $ret;
4569
  }
4570 17
4571
  /**
4572 17
   * Optimized "\mb_detect_encoding()"-function -> with support for UTF-16 and UTF-32.
4573
   *
4574
   * @param string $str
4575
   *
4576
   * @return false|string The detected string-encoding e.g. UTF-8 or UTF-16BE,<br />
4577
   *                      otherwise it will return false.
4578 17
   */
4579 17
  public static function str_detect_encoding($str)
4580 17
  {
4581 17
4582 17
    //
4583 16
    // 1.) check binary strings (010001001...) like UTF-16 / UTF-32
4584 16
    //
4585 17
4586
    if (self::is_binary($str)) {
4587
      if (self::is_utf16($str) === 1) {
4588
        return 'UTF-16LE';
4589
      } elseif (self::is_utf16($str) === 2) {
4590 17
        return 'UTF-16BE';
4591 17
      } elseif (self::is_utf32($str) === 1) {
4592
        return 'UTF-32LE';
4593
      } elseif (self::is_utf32($str) === 2) {
4594 1
        return 'UTF-32BE';
4595 1
      }
4596
    }
4597
4598 1
    //
4599 1
    // 2.) simple check for ASCII chars
4600 1
    //
4601 1
4602 1
    if (self::is_ascii($str) === true) {
4603
      return 'ASCII';
4604 1
    }
4605
4606 1
    //
4607
    // 3.) simple check for UTF-8 chars
4608
    //
4609
4610
    if (self::is_utf8($str) === true) {
4611
      return 'UTF-8';
4612
    }
4613
4614
    //
4615
    // 4.) check via "\mb_detect_encoding()"
4616 1
    //
4617
    // INFO: UTF-16, UTF-32, UCS2 and UCS4, encoding detection will fail always with "\mb_detect_encoding()"
4618 1
4619
    $detectOrder = array(
4620 1
        'windows-1251',
4621
        'ISO-8859-1',
4622
        'ASCII',
4623
        'UTF-8',
4624
    );
4625 1
4626 1
    self::checkForSupport();
4627
4628
    $encoding = \mb_detect_encoding($str, $detectOrder, true);
4629 1
    if ($encoding) {
4630 1
      return $encoding;
4631 1
    }
4632
4633 1
    //
4634
    // 5.) check via "iconv()"
4635
    //
4636
4637
    $md5 = md5($str);
4638
    foreach (self::$iconvEncoding as $encodingTmp) {
4639
      # INFO: //IGNORE and //TRANSLIT still throw notice
4640
      /** @noinspection PhpUsageOfSilenceOperatorInspection */
4641
      if (md5(@iconv($encodingTmp, $encodingTmp, $str)) === $md5) {
4642
        return $encodingTmp;
4643
      }
4644
    }
4645
4646
    return false;
4647
  }
4648
4649
  /**
4650
   * Case-insensitive and UTF-8 safe version of <function>str_replace</function>.
4651
   *
4652
   * @link  http://php.net/manual/en/function.str-ireplace.php
4653
   *
4654 8
   * @param mixed $search  <p>
4655
   *                       Every replacement with search array is
4656 8
   *                       performed on the result of previous replacement.
4657
   *                       </p>
4658 8
   * @param mixed $replace <p>
4659
   *                       </p>
4660 8
   * @param mixed $subject <p>
4661 2
   *                       If subject is an array, then the search and
4662
   *                       replace is performed with every entry of
4663
   *                       subject, and the return value is an array as
4664 7
   *                       well.
4665
   *                       </p>
4666 7
   * @param int   $count   [optional] <p>
4667 7
   *                       The number of matched and replaced needles will
4668 7
   *                       be returned in count which is passed by
4669
   *                       reference.
4670 7
   *                       </p>
4671
   *
4672 7
   * @return mixed a string or an array of replacements.
4673 6
   * @since 5.0
4674
   */
4675
  public static function str_ireplace($search, $replace, $subject, &$count = null)
4676 4
  {
4677
    $search = (array)$search;
4678
4679 4
    /** @noinspection AlterInForeachInspection */
4680 4
    foreach ($search as &$s) {
4681 4
      if ('' === $s .= '') {
4682
        $s = '/^(?<=.)$/';
4683 4
      } else {
4684 3
        $s = '/' . preg_quote($s, '/') . '/ui';
4685
      }
4686 3
    }
4687 3
4688 3
    $subject = preg_replace($search, $replace, $subject, -1, $replace);
4689
    $count = $replace;
4690 3
4691 1
    return $subject;
4692
  }
4693 1
4694 1
  /**
4695 1
   * Limit the number of characters in a string, but also after the next word.
4696
   *
4697 1
   * @param  string $str
4698
   * @param  int    $length
4699
   * @param  string $strAddOn
4700
   *
4701
   * @return string
4702
   */
4703
  public static function str_limit_after_word($str, $length = 100, $strAddOn = '...')
4704
  {
4705
    $str = (string)$str;
4706
4707
    if (!isset($str[0])) {
4708
      return '';
4709
    }
4710
4711
    $length = (int)$length;
4712 1
4713 3
    if (self::strlen($str) <= $length) {
4714
      return $str;
4715 4
    }
4716
4717
    if (self::substr($str, $length - 1, 1) === ' ') {
4718
      return self::substr($str, 0, $length - 1) . $strAddOn;
4719
    }
4720 4
4721
    $str = self::substr($str, 0, $length);
4722
    $array = explode(' ', $str);
4723
    array_pop($array);
4724
    $new_str = implode(' ', $array);
4725 4
4726 4
    if ($new_str === '') {
4727 2
      $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...
4728 2
    } else {
4729
      $str = $new_str . $strAddOn;
4730 2
    }
4731 2
4732 1
    return $str;
4733
  }
4734 2
4735
  /**
4736 4
   * Pad a UTF-8 string to given length with another string.
4737 4
   *
4738 4
   * @param    string $str        The input string
4739 4
   * @param    int    $pad_length The length of return string
4740 1
   * @param    string $pad_string String to use for padding the input string
4741
   * @param    int    $pad_type   can be STR_PAD_RIGHT, STR_PAD_LEFT or STR_PAD_BOTH
4742 7
   *
4743
   * @return   string Returns the padded string
4744 7
   */
4745
  public static function str_pad($str, $pad_length, $pad_string = ' ', $pad_type = STR_PAD_RIGHT)
4746
  {
4747
    $str_length = self::strlen($str);
4748
4749
    if (is_int($pad_length) && ($pad_length > 0) && ($pad_length >= $str_length)) {
4750
      $ps_length = self::strlen($pad_string);
4751
4752
      $diff = $pad_length - $str_length;
4753
4754
      switch ($pad_type) {
4755 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...
4756 1
          $pre = str_repeat($pad_string, (int)ceil($diff / $ps_length));
4757
          $pre = self::substr($pre, 0, $diff);
4758 1
          $post = '';
4759 1
          break;
4760 1
4761 1
        case STR_PAD_BOTH:
4762
          $pre = str_repeat($pad_string, (int)ceil($diff / $ps_length / 2));
4763 1
          $pre = self::substr($pre, 0, (int)$diff / 2);
4764
          $post = str_repeat($pad_string, (int)ceil($diff / $ps_length / 2));
4765
          $post = self::substr($post, 0, (int)ceil($diff / 2));
4766
          break;
4767 1
4768
        case STR_PAD_RIGHT:
4769 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...
4770
          $post = str_repeat($pad_string, (int)ceil($diff / $ps_length));
4771
          $post = self::substr($post, 0, $diff);
4772
          $pre = '';
4773
      }
4774
4775
      return $pre . $str . $post;
4776 1
    }
4777
4778
    return $str;
4779 1
  }
4780
4781
  /**
4782
   * Repeat a string.
4783
   *
4784
   * @param string $str        <p>
4785
   *                           The string to be repeated.
4786
   *                           </p>
4787
   * @param int    $multiplier <p>
4788
   *                           Number of time the input string should be
4789
   *                           repeated.
4790 8
   *                           </p>
4791
   *                           <p>
4792 8
   *                           multiplier has to be greater than or equal to 0.
4793
   *                           If the multiplier is set to 0, the function
4794
   *                           will return an empty string.
4795
   *                           </p>
4796
   *
4797
   * @return string the repeated string.
4798
   */
4799
  public static function str_repeat($str, $multiplier)
4800
  {
4801
    $str = self::filter($str);
4802
4803
    return str_repeat($str, $multiplier);
4804
  }
4805 8
4806
  /**
4807 8
   * INFO: this is only a wrapper for "str_replace()"  -> the original functions is already UTF-8 safe
4808 5
   *
4809 5
   * (PHP 4, PHP 5)<br/>
4810 8
   * Replace all occurrences of the search string with the replacement string
4811
   *
4812
   * @link http://php.net/manual/en/function.str-replace.php
4813
   *
4814
   * @param mixed $search  <p>
4815
   *                       The value being searched for, otherwise known as the needle.
4816
   *                       An array may be used to designate multiple needles.
4817
   *                       </p>
4818
   * @param mixed $replace <p>
4819
   *                       The replacement value that replaces found search
4820
   *                       values. An array may be used to designate multiple replacements.
4821
   *                       </p>
4822
   * @param mixed $subject <p>
4823 5
   *                       The string or array being searched and replaced on,
4824
   *                       otherwise known as the haystack.
4825 5
   *                       </p>
4826
   *                       <p>
4827
   *                       If subject is an array, then the search and
4828
   *                       replace is performed with every entry of
4829 5
   *                       subject, and the return value is an array as
4830
   *                       well.
4831
   *                       </p>
4832 5
   * @param int   $count   [optional] If passed, this will hold the number of matched and replaced needles.
4833
   *
4834
   * @return mixed This function returns a string or an array with the replaced values.
4835
   */
4836 5
  public static function str_replace($search, $replace, $subject, &$count = null)
4837 5
  {
4838
    return str_replace($search, $replace, $subject, $count);
4839
  }
4840
4841
  /**
4842
   * Shuffles all the characters in the string.
4843
   *
4844
   * @param    string $str The input string
4845
   *
4846
   * @return   string The shuffled string.
4847
   */
4848
  public static function str_shuffle($str)
4849
  {
4850 2
    $array = self::split($str);
4851
4852 2
    shuffle($array);
4853 2
4854
    return implode('', $array);
4855 2
  }
4856 2
4857 2
  /**
4858
   * Sort all characters according to code points.
4859 2
   *
4860 2
   * @param    string $str    A UTF-8 string.
4861
   * @param    bool   $unique Sort unique. If true, repeated characters are ignored.
4862
   * @param    bool   $desc   If true, will sort characters in reverse code point order.
4863
   *
4864
   * @return   string String of sorted characters
4865
   */
4866
  public static function str_sort($str, $unique = false, $desc = false)
4867
  {
4868
    $array = self::codepoints($str);
4869
4870 1
    if ($unique) {
4871
      $array = array_flip(array_flip($array));
4872 1
    }
4873
4874
    if ($desc) {
4875
      arsort($array);
4876
    } else {
4877
      asort($array);
4878
    }
4879
4880
    return self::string($array);
4881
  }
4882
4883
  /**
4884
   * Convert a string to an array.
4885
   *
4886
   * @param string $str
4887
   * @param int    $len
4888
   *
4889
   * @return array
4890
   */
4891
  public static function str_split($str, $len = 1)
4892
  {
4893
    // init
4894 2
    self::checkForSupport();
4895
    $len = (int)$len;
4896
4897 2
    if ($len < 1) {
4898
      return str_split($str, $len);
4899 2
    }
4900
4901
    preg_match_all('/' . Grapheme::GRAPHEME_CLUSTER_RX . '/u', $str, $a);
4902
    $a = $a[0];
4903
4904
    if ($len === 1) {
4905
      return $a;
4906
    }
4907
4908
    $arrayOutput = array();
4909
    $p = -1;
4910
4911
    /** @noinspection PhpForeachArrayIsUsedAsValueInspection */
4912
    foreach ($a as $l => $a) {
4913
      if ($l % $len) {
4914
        $arrayOutput[$p] .= $a;
4915
      } else {
4916
        $arrayOutput[++$p] = $a;
4917
      }
4918
    }
4919
4920
    return $arrayOutput;
4921
  }
4922
4923
  /**
4924
   * Convert binary into an string.
4925 8
   *
4926
   * @param $bin 1|0
4927 8
   *
4928 8
   * @return string
4929
   */
4930 8
  public static function binary_to_str($bin)
4931 2
  {
4932
    return pack('H*', base_convert($bin, 2, 16));
4933
  }
4934
4935 7
  /**
4936
   * Get a binary representation of a specific string.
4937 7
   *
4938 1
   * @param   string $str The input string.
4939 1
   *
4940 1
   * @return  string
4941
   */
4942
  public static function str_to_binary($str)
4943 7
  {
4944 1
    $str = (string)$str;
4945 1
4946
    $value = unpack('H*', $str);
4947 7
4948
    return base_convert($value[1], 16, 2);
4949
  }
4950
4951
  /**
4952
   * alias for "UTF8::to_ascii()"
4953
   *
4954
   * @param string $str
4955
   * @param string $unknown
4956
   *
4957
   * @return string
4958
   */
4959 7
  public static function str_transliterate($str, $unknown = '?')
4960
  {
4961 7
    return self::to_ascii($str, $unknown);
4962 2
  }
4963
4964
  /**
4965
   * Counts number of words in the UTF-8 string.
4966 5
   *
4967
   * @param string $str    The input string.
4968 5
   * @param int    $format <strong>0</strong> => return a number of words<br />
4969
   *                       <strong>1</strong> => return an array of words
4970
   *                       <strong>2</strong> => return an array of words with word-offset as key
4971
   * @param string $charlist
4972
   *
4973
   * @return array|float The number of words in the string
4974
   */
4975
  public static function str_word_count($str, $format = 0, $charlist = '')
4976
  {
4977
    $charlist = self::rxClass($charlist, '\pL');
4978
    $strParts = \preg_split("/({$charlist}+(?:[\p{Pd}’']{$charlist}+)*)/u", $str, -1, PREG_SPLIT_DELIM_CAPTURE);
4979
4980
    $len = count($strParts);
4981
4982
    if ($format === 1) {
4983
4984
      $numberOfWords = array();
4985 66
      for ($i = 1; $i < $len; $i += 2) {
4986
        $numberOfWords[] = $strParts[$i];
4987 66
      }
4988
4989 66
    } elseif ($format === 2) {
4990 4
4991
      self::checkForSupport();
4992
4993
      $numberOfWords = array();
4994 65
      $offset = self::strlen($strParts[0]);
4995
      for ($i = 1; $i < $len; $i += 2) {
4996
        $numberOfWords[$offset] = $strParts[$i];
4997 65
        $offset += self::strlen($strParts[$i]) + self::strlen($strParts[$i + 1]);
4998
      }
4999
5000
    } else {
5001 65
5002
      $numberOfWords = ($len - 1) / 2;
5003
5004
    }
5005 65
5006
    return $numberOfWords;
5007
  }
5008
5009
  /**
5010
   * Case-insensitive string comparison.
5011
   *
5012
   * @param string $str1
5013
   * @param string $str2
5014
   *
5015
   * @return int Returns < 0 if str1 is less than str2; > 0 if str1 is greater than str2, and 0 if they are equal.
5016
   */
5017 1
  public static function strcasecmp($str1, $str2)
5018
  {
5019 1
    return self::strcmp(self::strtocasefold($str1), self::strtocasefold($str2));
5020
  }
5021
5022
  /**
5023
   * String comparison.
5024
   *
5025
   * @param string $str1
5026
   * @param string $str2
5027
   *
5028
   * @return int  <strong>< 0</strong> if str1 is less than str2<br />
5029
   *              <strong>> 0</strong> if str1 is greater than str2<br />
5030
   *              <strong>0</strong> if they are equal.
5031 2
   */
5032
  public static function strcmp($str1, $str2)
5033 2
  {
5034
    return $str1 . '' === $str2 . '' ? 0 : strcmp(
5035
        \Normalizer::normalize($str1, \Normalizer::NFD),
5036
        \Normalizer::normalize($str2, \Normalizer::NFD)
5037
    );
5038
  }
5039
5040
  /**
5041
   * Find length of initial segment not matching mask.
5042
   *
5043
   * @param string $str
5044
   * @param string $charList
5045
   * @param int    $offset
5046
   * @param int    $length
5047
   *
5048
   * @return int|null
5049
   */
5050
  public static function strcspn($str, $charList, $offset = 0, $length = 2147483647)
5051
  {
5052
    if ('' === $charList .= '') {
5053
      return null;
5054
    }
5055
5056
    if ($offset || 2147483647 !== $length) {
5057
      $str = (string)self::substr($str, $offset, $length);
5058
    } else {
5059
      $str = (string)$str;
5060
    }
5061
5062
    if (preg_match('/^(.*?)' . self::rxClass($charList) . '/us', $str, $length)) {
5063
      /** @noinspection OffsetOperationsInspection */
5064
      return self::strlen($length[1]);
5065
    } else {
5066
      return self::strlen($str);
5067
    }
5068
  }
5069
5070
  /**
5071
   * Makes a UTF-8 string from code points.
5072
   *
5073
   * @param    array $array Integer or Hexadecimal codepoints
5074
   *
5075
   * @return   string UTF-8 encoded string
5076
   */
5077
  public static function string($array)
5078
  {
5079
    return implode(
5080
        array_map(
5081
            array(
5082
                '\\voku\\helper\\UTF8',
5083
                'chr',
5084
            ),
5085
            $array
5086
        )
5087
    );
5088
  }
5089
5090
  /**
5091
   * Checks if string starts with "BOM" (Byte Order Mark Character) character.
5092
   *
5093
   * @param    string $str The input string.
5094
   *
5095
   * @return   bool True if the string has BOM at the start, False otherwise.
5096
   */
5097
  public static function string_has_bom($str)
5098
  {
5099
    foreach (self::$bom as $bomString => $bomByteLength) {
5100
      if (0 === strpos($str, $bomString)) {
5101
        return true;
5102
      }
5103 11
    }
5104
5105 11
    return false;
5106 11
  }
5107
5108 11
  /**
5109 2
   * Strip HTML and PHP tags from a string.
5110
   *
5111
   * @link http://php.net/manual/en/function.strip-tags.php
5112
   *
5113 10
   * @param string $str            <p>
5114 10
   *                               The input string.
5115
   *                               </p>
5116
   * @param string $allowable_tags [optional] <p>
5117
   *                               You can use the optional second parameter to specify tags which should
5118 10
   *                               not be stripped.
5119
   *                               </p>
5120
   *                               <p>
5121
   *                               HTML comments and PHP tags are also stripped. This is hardcoded and
5122 10
   *                               can not be changed with allowable_tags.
5123
   *                               </p>
5124
   *
5125
   * @return string the stripped string.
5126 1
   */
5127 1
  public static function strip_tags($str, $allowable_tags = null)
5128 1
  {
5129
    //clean broken utf8
5130 10
    $str = self::clean($str);
5131
5132
    return strip_tags($str, $allowable_tags);
5133 10
  }
5134 1
5135 1
  /**
5136
   * Finds position of first occurrence of a string within another, case insensitive.
5137 10
   *
5138
   * @link http://php.net/manual/en/function.mb-stripos.php
5139
   *
5140
   * @param string  $haystack  <p>
5141
   *                           The string from which to get the position of the first occurrence
5142
   *                           of needle
5143
   *                           </p>
5144
   * @param string  $needle    <p>
5145
   *                           The string to find in haystack
5146
   *                           </p>
5147
   * @param int     $offset    [optional] <p>
5148
   *                           The position in haystack
5149
   *                           to start searching
5150
   *                           </p>
5151
   * @param string  $encoding
5152
   * @param boolean $cleanUtf8 Clean non UTF-8 chars from the string
5153
   *
5154
   * @return int Return the numeric position of the first occurrence of
5155
   * needle in the haystack
5156
   * string, or false if needle is not found.
5157
   */
5158
  public static function stripos($haystack, $needle, $offset = null, $encoding = 'UTF-8', $cleanUtf8 = false)
5159
  {
5160
    $haystack = (string)$haystack;
5161
    $needle = (string)$needle;
5162
5163
    if (!isset($haystack[0], $needle[0])) {
5164
      return false;
5165
    }
5166
5167
    // init
5168
    self::checkForSupport();
5169
5170
    if ($cleanUtf8 === true) {
5171
      $haystack = self::clean($haystack);
5172
      $needle = self::clean($needle);
5173
    }
5174
5175
    // INFO: this is only a fallback for old versions
5176
    if ($encoding === true || $encoding === false) {
5177
      $encoding = 'UTF-8';
5178
    } else {
5179
      $encoding = self::normalizeEncoding($encoding);
5180
    }
5181
5182
    return \mb_stripos($haystack, $needle, $offset, $encoding);
5183
  }
5184
5185
  /**
5186 1
   * Returns all of haystack starting from and including the first occurrence of needle to the end.
5187
   *
5188 1
   * @param string $str
5189
   * @param string $needle
5190 1
   * @param bool   $before_needle
5191
   *
5192
   * @return false|string
5193
   */
5194
  public static function stristr($str, $needle, $before_needle = false)
5195
  {
5196
    if ('' === $needle .= '') {
5197
      return false;
5198
    }
5199
5200 4
    // init
5201
    self::checkForSupport();
5202 4
5203
    return \mb_stristr($str, $needle, $before_needle, 'UTF-8');
5204
  }
5205
5206
  /**
5207
   * Get the string length, not the byte-length!
5208
   *
5209
   * @link     http://php.net/manual/en/function.mb-strlen.php
5210
   *
5211
   * @param string  $str       The string being checked for length.
5212
   * @param string  $encoding  Set the charset for e.g. "\mb_" function
5213
   * @param boolean $cleanUtf8 Clean non UTF-8 chars from the string
5214
   *
5215
   * @return int the number of characters in
5216
   *           string str having character encoding
5217
   *           encoding. A multi-byte character is
5218
   *           counted as 1.
5219
   */
5220
  public static function strlen($str, $encoding = 'UTF-8', $cleanUtf8 = false)
5221
  {
5222
    $str = (string)$str;
5223
5224
    if (!isset($str[0])) {
5225
      return 0;
5226
    }
5227
5228
    // INFO: this is only a fallback for old versions
5229
    if ($encoding === true || $encoding === false) {
5230
      $encoding = 'UTF-8';
5231
    } else {
5232
      $encoding = self::normalizeEncoding($encoding);
5233 1
    }
5234
5235 1
    switch ($encoding) {
5236
      case 'ASCII':
5237 1
      case 'CP850':
5238
        return strlen($str);
5239
    }
5240
5241
    self::checkForSupport();
5242
5243
    if ($encoding === 'UTF-8' && $cleanUtf8 === true) {
5244
      $str = self::clean($str);
5245
    }
5246
5247
    return \mb_strlen($str, $encoding);
5248
  }
5249 1
5250
  /**
5251 1
   * Case insensitive string comparisons using a "natural order" algorithm.
5252
   *
5253
   * @param string $str1
5254
   * @param string $str2
5255
   *
5256
   * @return int <strong>< 0</strong> if str1 is less than str2<br />
5257
   *             <strong>> 0</strong> if str1 is greater than str2<br />
5258
   *             <strong>0</strong> if they are equal
5259
   */
5260
  public static function strnatcasecmp($str1, $str2)
5261
  {
5262
    return self::strnatcmp(self::strtocasefold($str1), self::strtocasefold($str2));
5263
  }
5264
5265
  /**
5266
   * String comparisons using a "natural order" algorithm
5267
   *
5268
   * @link  http://php.net/manual/en/function.strnatcmp.php
5269
   *
5270
   * @param string $str1 <p>
5271
   *                     The first string.
5272
   *                     </p>
5273
   * @param string $str2 <p>
5274
   *                     The second string.
5275
   *                     </p>
5276 10
   *
5277
   * @return int Similar to other string comparison functions, this one returns &lt; 0 if
5278 10
   * str1 is less than str2; &gt;
5279 10
   * 0 if str1 is greater than
5280
   * str2, and 0 if they are equal.
5281 10
   * @since 4.0
5282 2
   * @since 5.0
5283
   */
5284
  public static function strnatcmp($str1, $str2)
5285
  {
5286 9
    return $str1 . '' === $str2 . '' ? 0 : strnatcmp(self::strtonatfold($str1), self::strtonatfold($str2));
5287
  }
5288 9
5289
  /**
5290
   * Binary safe case-insensitive string comparison of the first n characters
5291
   *
5292 9
   * @link  http://php.net/manual/en/function.strncasecmp.php
5293 9
   *
5294
   * @param string $str1 <p>
5295 9
   *                     The first string.
5296
   *                     </p>
5297
   * @param string $str2 <p>
5298 1
   *                     The second string.
5299 1
   *                     </p>
5300 1
   * @param int    $len  <p>
5301
   *                     The length of strings to be used in the comparison.
5302 9
   *                     </p>
5303 9
   *
5304
   * @return int &lt; 0 if <i>str1</i> is less than
5305
   * <i>str2</i>; &gt; 0 if <i>str1</i> is
5306
   * greater than <i>str2</i>, and 0 if they are equal.
5307
   * @since 4.0.4
5308
   * @since 5.0
5309
   */
5310
  public static function strncasecmp($str1, $str2, $len)
5311
  {
5312
    return self::strncmp(self::strtocasefold($str1), self::strtocasefold($str2), $len);
5313
  }
5314
5315
  /**
5316
   * Binary safe string comparison of the first n characters
5317
   *
5318
   * @link  http://php.net/manual/en/function.strncmp.php
5319
   *
5320
   * @param string $str1 <p>
5321
   *                     The first string.
5322
   *                     </p>
5323
   * @param string $str2 <p>
5324
   *                     The second string.
5325
   *                     </p>
5326
   * @param int    $len  <p>
5327
   *                     Number of characters to use in the comparison.
5328
   *                     </p>
5329
   *
5330
   * @return int &lt; 0 if <i>str1</i> is less than
5331
   * <i>str2</i>; &gt; 0 if <i>str1</i>
5332
   * is greater than <i>str2</i>, and 0 if they are
5333
   * equal.
5334
   * @since 4.0
5335
   * @since 5.0
5336
   */
5337
  public static function strncmp($str1, $str2, $len)
5338
  {
5339 6
    return self::strcmp(self::substr($str1, 0, $len), self::substr($str2, 0, $len));
0 ignored issues
show
Security Bug introduced by
It seems like self::substr($str1, 0, $len) targeting voku\helper\UTF8::substr() 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?
Loading history...
Security Bug introduced by
It seems like self::substr($str2, 0, $len) targeting voku\helper\UTF8::substr() 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?
Loading history...
5340
  }
5341 6
5342
  /**
5343
   * Search a string for any of a set of characters
5344
   *
5345 6
   * @link  http://php.net/manual/en/function.strpbrk.php
5346
   *
5347
   * @param string $haystack  <p>
5348
   *                          The string where char_list is looked for.
5349
   *                          </p>
5350
   * @param string $char_list <p>
5351
   *                          This parameter is case sensitive.
5352
   *                          </p>
5353
   *
5354
   * @return string a string starting from the character found, or false if it is
5355
   * not found.
5356
   * @since 5.0
5357
   */
5358
  public static function strpbrk($haystack, $char_list)
5359
  {
5360
    $haystack = (string)$haystack;
5361
    $char_list = (string)$char_list;
5362
5363
    if (!isset($haystack[0], $char_list[0])) {
5364
      return false;
5365
    }
5366 1
5367
    if (preg_match('/' . self::rxClass($char_list) . '/us', $haystack, $m)) {
5368 1
      return substr($haystack, strpos($haystack, $m[0]));
5369
    } else {
5370 1
      return false;
5371
    }
5372
  }
5373
5374
  /**
5375
   * Find position of first occurrence of string in a string.
5376
   *
5377
   * @link http://php.net/manual/en/function.mb-strpos.php
5378
   *
5379
   * @param string  $haystack     <p>
5380
   *                              The string being checked.
5381
   *                              </p>
5382
   * @param string  $needle       <p>
5383 10
   *                              The position counted from the beginning of haystack.
5384
   *                              </p>
5385 10
   * @param int     $offset       [optional] <p>
5386 10
   *                              The search offset. If it is not specified, 0 is used.
5387 10
   *                              </p>
5388
   * @param string  $encoding
5389 10
   * @param boolean $cleanUtf8    Clean non UTF-8 chars from the string.
5390 1
   *
5391 1
   * @return int The numeric position of the first occurrence of needle in the haystack string.<br />
5392 1
   *             If needle is not found it returns false.
5393
   */
5394 10
  public static function strpos($haystack, $needle, $offset = 0, $encoding = 'UTF-8', $cleanUtf8 = false)
5395
  {
5396 10
    $haystack = (string)$haystack;
5397
    $needle = (string)$needle;
5398 10
5399 1
    if (!isset($haystack[0], $needle[0])) {
5400 1
      return false;
5401
    }
5402
5403 10
    // init
5404 10
    self::checkForSupport();
5405
    $offset = (int)$offset;
5406 10
5407
    // iconv and mbstring do not support integer $needle
5408 10
5409
    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...
5410
      $needle = self::chr($needle);
5411
    }
5412
5413
    if ($cleanUtf8 === true) {
5414
      // \mb_strpos returns wrong position if invalid characters are found in $haystack before $needle
5415
      // iconv_strpos is not tolerant to invalid characters
5416
5417
      $needle = self::clean((string)$needle);
5418
      $haystack = self::clean($haystack);
5419
    }
5420
5421 View Code Duplication
    if (self::$support['mbstring'] === true) {
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...
5422
5423
      // INFO: this is only a fallback for old versions
5424 20
      if ($encoding === true || $encoding === false) {
5425
        $encoding = 'UTF-8';
5426 20
      } else {
5427
        $encoding = self::normalizeEncoding($encoding);
5428 20
      }
5429 5
5430
      return \mb_strpos($haystack, $needle, $offset, $encoding);
5431
    }
5432
5433 18
    if (self::$support['iconv'] === true) {
5434
      // ignore invalid negative offset to keep compatility
5435 18
      // 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...
5436
      return \grapheme_strpos($haystack, $needle, $offset > 0 ? $offset : 0);
5437
    }
5438
5439
    if ($offset > 0) {
5440
      $haystack = self::substr($haystack, $offset);
5441
    }
5442
5443 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...
5444
      $left = substr($haystack, 0, $pos);
5445 3
5446
      // negative offset not supported in PHP strpos(), ignoring
5447 3
      return ($offset > 0 ? $offset : 0) + self::strlen($left);
5448
    }
5449
5450
    return false;
5451
  }
5452
5453
  /**
5454
   * Finds the last occurrence of a character in a string within another.
5455
   *
5456
   * @link http://php.net/manual/en/function.mb-strrchr.php
5457
   *
5458
   * @param string $haystack <p>
5459
   *                         The string from which to get the last occurrence
5460
   *                         of needle
5461
   *                         </p>
5462 16
   * @param string $needle   <p>
5463
   *                         The string to find in haystack
5464 16
   *                         </p>
5465
   * @param bool   $part     [optional] <p>
5466 16
   *                         Determines which portion of haystack
5467 4
   *                         this function returns.
5468
   *                         If set to true, it returns all of haystack
5469
   *                         from the beginning to the last occurrence of needle.
5470
   *                         If set to false, it returns all of haystack
5471 15
   *                         from the last occurrence of needle to the end,
5472
   *                         </p>
5473 15
   * @param string $encoding [optional] <p>
5474 15
   *                         Character encoding name to use.
5475
   *                         If it is omitted, internal character encoding is used.
5476
   *                         </p>
5477
   *
5478
   * @return string the portion of haystack.
5479
   * or false if needle is not found.
5480
   */
5481 View Code Duplication
  public static function strrchr($haystack, $needle, $part = false, $encoding = 'UTF-8')
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...
5482
  {
5483
    self::checkForSupport();
5484
    $encoding = self::normalizeEncoding($encoding);
5485
5486
    return \mb_strrchr($haystack, $needle, $part, $encoding);
5487
  }
5488
5489
  /**
5490
   * Reverses characters order in the string.
5491
   *
5492
   * @param    string $str The input string
5493
   *
5494
   * @return   string The string with characters in the reverse sequence
5495
   */
5496
  public static function strrev($str)
5497
  {
5498
    return implode(array_reverse(self::split($str)));
5499
  }
5500
5501
  /**
5502
   * Finds the last occurrence of a character in a string within another, case insensitive.
5503 1
   *
5504
   * @link http://php.net/manual/en/function.mb-strrichr.php
5505 1
   *
5506
   * @param string $haystack <p>
5507
   *                         The string from which to get the last occurrence
5508
   *                         of needle
5509
   *                         </p>
5510
   * @param string $needle   <p>
5511
   *                         The string to find in haystack
5512
   *                         </p>
5513
   * @param bool   $part     [optional] <p>
5514
   *                         Determines which portion of haystack
5515
   *                         this function returns.
5516
   *                         If set to true, it returns all of haystack
5517
   *                         from the beginning to the last occurrence of needle.
5518
   *                         If set to false, it returns all of haystack
5519
   *                         from the last occurrence of needle to the end,
5520 1
   *                         </p>
5521
   * @param string $encoding [optional] <p>
5522
   *                         Character encoding name to use.
5523
   *                         If it is omitted, internal character encoding is used.
5524
   *                         </p>
5525
   *
5526
   * @return string the portion of haystack.
5527
   * or false if needle is not found.
5528
   */
5529 View Code Duplication
  public static function strrichr($haystack, $needle, $part = false, $encoding = 'UTF-8')
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...
5530 1
  {
5531
    self::checkForSupport();
5532
    $encoding = self::normalizeEncoding($encoding);
5533 1
5534
    return \mb_strrichr($haystack, $needle, $part, $encoding);
5535 1
  }
5536
5537
  /**
5538
   * Find position of last occurrence of a case-insensitive string.
5539
   *
5540
   * @param    string $haystack The string to look in
5541
   * @param    string $needle   The string to look for
5542
   * @param    int    $offset   (Optional) Number of characters to ignore in the beginning or end
5543
   *
5544
   * @return   int The position of offset
5545
   */
5546
  public static function strripos($haystack, $needle, $offset = 0)
5547
  {
5548
    return self::strrpos(self::strtolower($haystack), self::strtolower($needle), $offset);
5549
  }
5550
5551
  /**
5552
   * Find position of last occurrence of a string in a string.
5553
   *
5554
   * @link http://php.net/manual/en/function.mb-strrpos.php
5555
   *
5556
   * @param string     $haystack  <p>
5557
   *                              The string being checked, for the last occurrence
5558 39
   *                              of needle
5559
   *                              </p>
5560 39
   * @param string|int $needle    <p>
5561
   *                              The string to find in haystack.
5562 39
   *                              Or a code point as int.
5563 9
   *                              </p>
5564
   * @param int        $offset    [optional] May be specified to begin searching an arbitrary number of characters into
5565
   *                              the string. Negative values will stop searching at an arbitrary point
5566
   *                              prior to the end of the string.
5567 37
   * @param boolean    $cleanUtf8 Clean non UTF-8 chars from the string
5568
   *
5569 37
   * @return int the numeric position of
5570
   * the last occurrence of needle in the
5571
   * haystack string. If
5572
   * needle is not found, it returns false.
5573 1
   */
5574 1
  public static function strrpos($haystack, $needle, $offset = null, $cleanUtf8 = false)
5575
  {
5576 37
    $haystack = (string)$haystack;
5577 22
5578 22
    if (((int)$needle) === $needle && ($needle >= 0)) {
5579 33
      $needle = self::chr($needle);
5580
    }
5581
5582 37
    $needle = (string)$needle;
5583
5584
    if (!isset($haystack[0], $needle[0])) {
5585 37
      return false;
5586 1
    }
5587 1
5588
    // init
5589 37
    self::checkForSupport();
5590
5591
    $needle = (string)$needle;
5592
    $offset = (int)$offset;
5593
5594
    if ($cleanUtf8 === true) {
5595
      // \mb_strrpos && iconv_strrpos is not tolerant to invalid characters
5596
5597
      $needle = self::clean($needle);
5598
      $haystack = self::clean($haystack);
5599
    }
5600
5601
    if (self::$support['mbstring'] === true) {
5602
      return \mb_strrpos($haystack, $needle, $offset, 'UTF-8');
5603
    }
5604
5605
    if (self::$support['iconv'] === true) {
5606
      return \grapheme_strrpos($haystack, $needle, $offset);
5607
    }
5608
5609
    // fallback
5610
5611
    if ($offset > 0) {
5612
      $haystack = self::substr($haystack, $offset);
5613
    } elseif ($offset < 0) {
5614
      $haystack = self::substr($haystack, 0, $offset);
5615
    }
5616
5617 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...
5618 1
      $left = substr($haystack, 0, $pos);
5619
5620 1
      // negative offset not supported in PHP strpos(), ignoring
5621 1
      return ($offset > 0 ? $offset : 0) + self::strlen($left);
5622
    }
5623 1
5624
    return false;
5625
  }
5626
5627
  /**
5628
   * Finds the length of the initial segment of a string consisting entirely of characters contained within a given
5629
   * mask.
5630
   *
5631
   * @param string $str
5632
   * @param string $mask
5633
   * @param int    $offset
5634
   * @param int    $length
5635
   *
5636
   * @return int|null
5637
   */
5638
  public static function strspn($str, $mask, $offset = 0, $length = 2147483647)
5639
  {
5640
    if ($offset || 2147483647 !== $length) {
5641
      $str = self::substr($str, $offset, $length);
5642
    }
5643
5644
    return preg_match('/^' . self::rxClass($mask) . '+/u', $str, $str) ? self::strlen($str[0]) : 0;
5645
  }
5646
5647
  /**
5648
   * Returns part of haystack string from the first occurrence of needle to the end of haystack.
5649
   *
5650
   * @link http://php.net/manual/en/function.grapheme-strstr.php
5651
   *
5652
   * @param string $haystack      <p>
5653
   *                              The input string. Must be valid UTF-8.
5654
   *                              </p>
5655
   * @param string $needle        <p>
5656
   *                              The string to look for. Must be valid UTF-8.
5657
   *                              </p>
5658
   * @param bool   $before_needle [optional] <p>
5659
   *                              If <b>TRUE</b>, grapheme_strstr() returns the part of the
5660
   *                              haystack before the first occurrence of the needle (excluding the needle).
5661
   *                              </p>
5662
   *
5663
   * @return string the portion of string, or FALSE if needle is not found.
5664
   */
5665 6
  public static function strstr($haystack, $needle, $before_needle = false)
5666
  {
5667
    self::checkForSupport();
5668 6
5669 1
    return \grapheme_strstr($haystack, $needle, $before_needle);
5670
  }
5671
5672 1
  /**
5673 1
   * Unicode transformation for case-less matching.
5674 1
   *
5675 1
   * @link http://unicode.org/reports/tr21/tr21-5.html
5676
   *
5677
   * @param string $str
5678
   * @param bool   $full
5679 1
   *
5680 1
   * @return string
5681 1
   */
5682 1
  public static function strtocasefold($str, $full = true)
5683 1
  {
5684 1
    static $fullCaseFold = null;
5685 1
    static $commonCaseFoldKeys = null;
5686 1
    static $commonCaseFoldValues = null;
5687
5688
    if ($commonCaseFoldKeys === null) {
5689
      $commonCaseFoldKeys = array_keys(self::$commonCaseFold);
5690 1
      $commonCaseFoldValues = array_values(self::$commonCaseFold);
5691 1
    }
5692 1
5693 1
    $str = str_replace($commonCaseFoldKeys, $commonCaseFoldValues, $str);
5694 1
5695 1
    if ($full) {
5696 1
5697 1
      if ($fullCaseFold === null) {
5698
        $fullCaseFold = self::getData('caseFolding_full');
5699
      }
5700 1
5701 1
      /** @noinspection OffsetOperationsInspection */
5702 1
      $str = str_replace($fullCaseFold[0], $fullCaseFold[1], $str);
5703 1
    }
5704
5705
    $str = self::clean($str);
5706
5707 1
    return self::strtolower($str);
5708
  }
5709 6
5710 1
  /**
5711 1
   * (PHP 4 &gt;= 4.3.0, PHP 5)<br/>
5712 1
   * Make a string lowercase.
5713 1
   *
5714
   * @link http://php.net/manual/en/function.mb-strtolower.php
5715 1
   *
5716
   * @param string $str <p>
5717
   *                    The string being lowercased.
5718 6
   *                    </p>
5719 6
   * @param string $encoding
5720
   *
5721 6
   * @return string str with all alphabetic characters converted to lowercase.
5722 4
   */
5723
  public static function strtolower($str, $encoding = 'UTF-8')
5724 4
  {
5725 4
    $str = (string)$str;
5726
5727 6
    if (!isset($str[0])) {
5728
      return '';
5729 6
    }
5730
5731
    // init
5732
    self::checkForSupport();
5733
    $encoding = self::normalizeEncoding($encoding);
5734
5735
    return \mb_strtolower($str, $encoding);
5736
  }
5737
5738
  /**
5739
   * Generic case sensitive transformation for collation matching.
5740 1
   *
5741
   * @param string $s
5742 1
   *
5743
   * @return string
5744 1
   */
5745 1
  protected static function strtonatfold($s)
5746
  {
5747
    return preg_replace('/\p{Mn}+/u', '', \Normalizer::normalize($s, \Normalizer::NFD));
5748 1
  }
5749
5750 1
  /**
5751 1
   * Make a string uppercase.
5752
   *
5753 1
   * @link http://php.net/manual/en/function.mb-strtoupper.php
5754
   *
5755 1
   * @param string $str <p>
5756 1
   *                    The string being uppercased.
5757
   *                    </p>
5758 1
   * @param string $encoding
5759
   *
5760 1
   * @return string str with all alphabetic characters converted to uppercase.
5761
   */
5762 1
  public static function strtoupper($str, $encoding = 'UTF-8')
5763
  {
5764 1
    $str = (string)$str;
5765
5766
    if (!isset($str[0])) {
5767
      return '';
5768
    }
5769
5770
    // init
5771
    self::checkForSupport();
5772
5773
    if (self::$support['mbstring'] === true) {
5774
      $encoding = self::normalizeEncoding($encoding);
5775 6
5776
      return \mb_strtoupper($str, $encoding);
5777 6
    } else {
5778
5779
      // fallback
5780
5781
      static $caseTableKeys = null;
5782
      static $caseTableValues = null;
5783
5784
      if ($caseTableKeys === null) {
5785
        $caseTable = self::case_table();
5786
        $caseTableKeys = array_keys($caseTable);
5787
        $caseTableValues = array_values($caseTable);
5788
      }
5789
5790
      $str = self::clean($str);
5791
5792
      return str_replace($caseTableKeys, $caseTableValues, $str);
5793
    }
5794
  }
5795
5796
  /**
5797
   * Translate characters or replace sub-strings.
5798
   *
5799
   * @link  http://php.net/manual/en/function.strtr.php
5800
   *
5801
   * @param string       $str  <p>
5802
   *                           The string being translated.
5803
   *                           </p>
5804
   * @param string|array $from <p>
5805
   *                           The string replacing from.
5806
   *                           </p>
5807
   * @param string|array $to   <p>
5808
   *                           The string being translated to to.
5809
   *                           </p>
5810
   *
5811
   * @return string This function returns a copy of str,
5812 7
   * translating all occurrences of each character in
5813
   * from to the corresponding character in
5814 7
   * to.
5815
   * @since 4.0
5816 7
   * @since 5.0
5817
   */
5818 7
  public static function strtr($str, $from, $to = INF)
5819 2
  {
5820
    if (INF !== $to) {
5821
      $from = self::str_split($from);
0 ignored issues
show
Bug introduced by
It seems like $from defined by self::str_split($from) on line 5821 can also be of type array; 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...
5822 6
      $to = self::str_split($to);
0 ignored issues
show
Bug introduced by
It seems like $to defined by self::str_split($to) on line 5822 can also be of type array; 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...
5823
      $countFrom = count($from);
5824 6
      $countTo = count($to);
5825 3
5826
      if ($countFrom > $countTo) {
5827 3
        $from = array_slice($from, 0, $countTo);
5828
      } elseif ($countFrom < $countTo) {
5829 3
        $to = array_slice($to, 0, $countFrom);
5830
      }
5831
5832 3
      $from = array_combine($from, $to);
5833
    }
5834 3
5835 3
    return strtr($str, $from);
0 ignored issues
show
Bug introduced by
It seems like $from defined by parameter $from on line 5818 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...
5836
  }
5837
5838 3
  /**
5839 3
   * Return the width of a string.
5840 3
   *
5841
   * @param string $s
5842
   *
5843
   * @return int
5844
   */
5845
  public static function strwidth($s)
5846
  {
5847
    // init
5848
    self::checkForSupport();
5849
5850
    return \mb_strwidth($s, 'UTF-8');
5851
  }
5852 3
5853
  /**
5854 1
   * Get part of a string.
5855 1
   *
5856 1
   * @link http://php.net/manual/en/function.mb-substr.php
5857
   *
5858 1
   * @param string  $str       <p>
5859 1
   *                           The string being checked.
5860 1
   *                           </p>
5861 1
   * @param int     $start     <p>
5862
   *                           The first position used in str.
5863 1
   *                           </p>
5864
   * @param int     $length    [optional] <p>
5865
   *                           The maximum length of the returned string.
5866 1
   *                           </p>
5867
   * @param string  $encoding
5868
   * @param boolean $cleanUtf8 Clean non UTF-8 chars from the string
5869 1
   *
5870
   * @return string mb_substr returns the portion of
5871 3
   * str specified by the start and length parameters.
5872 1
   */
5873 1
  public static function substr($str, $start = 0, $length = null, $encoding = 'UTF-8', $cleanUtf8 = false)
5874
  {
5875 3
    $str = (string)$str;
5876 3
5877
    if (!isset($str[0])) {
5878 3
      return '';
5879 3
    }
5880
5881 6
    // init
5882
    self::checkForSupport();
5883
5884
    if ($cleanUtf8 === true) {
5885
      // iconv and mbstring are not tolerant to invalid encoding
5886
      // further, their behaviour is inconsistent with that of PHP's substr
5887
5888
      $str = self::clean($str);
5889
    }
5890
5891
    $str_length = 0;
5892
    if ($start || $length === null) {
5893
      $str_length = (int)self::strlen($str);
5894
    }
5895
5896
    if ($start && $start > $str_length) {
5897
      return false;
5898
    }
5899
5900
    if ($length === null) {
5901
      $length = $str_length;
5902
    } else {
5903 2
      $length = (int)$length;
5904
    }
5905 2
5906 View Code Duplication
    if (self::$support['mbstring'] === true) {
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...
5907
5908
      // INFO: this is only a fallback for old versions
5909
      if ($encoding === true || $encoding === false) {
5910
        $encoding = 'UTF-8';
5911
      } else {
5912
        $encoding = self::normalizeEncoding($encoding);
5913
      }
5914
5915
      return \mb_substr($str, $start, $length, $encoding);
5916
    }
5917
5918
    if (self::$support['iconv'] === true) {
5919
      return (string)\grapheme_substr($str, $start, $length);
5920
    }
5921
5922
    // fallback
5923
5924
    // split to array, and remove invalid characters
5925
    $array = self::split($str);
5926
5927
    // extract relevant part, and join to make sting again
5928
    return implode(array_slice($array, $start, $length));
5929 20
  }
5930
5931 20
  /**
5932 2
   * Binary safe comparison of two strings from an offset, up to length characters.
5933
   *
5934 2
   * @param string  $main_str           The main string being compared.
5935 2
   * @param string  $str                The secondary string being compared.
5936
   * @param int     $offset             The start position for the comparison. If negative, it starts counting from the
5937 2
   *                                    end of the string.
5938
   * @param int     $length             The length of the comparison. The default value is the largest of the length of
5939
   *                                    the str compared to the length of main_str less the offset.
5940 20
   * @param boolean $case_insensitivity If case_insensitivity is TRUE, comparison is case insensitive.
5941
   *
5942 20
   * @return int
5943 9
   */
5944
  public static function substr_compare($main_str, $str, $offset, $length = 2147483647, $case_insensitivity = false)
5945
  {
5946 20
    $main_str = self::substr($main_str, $offset, $length);
5947
    $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 5946 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...
5948 20
5949
    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 5946 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 5947 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 5946 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 5947 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...
5950 20
  }
5951 20
5952
  /**
5953 20
   * Count the number of substring occurrences
5954 20
   *
5955 20
   * @link  http://php.net/manual/en/function.substr-count.php
5956 20
   *
5957
   * @param string $haystack <p>
5958 20
   *                         The string to search in
5959
   *                         </p>
5960 18
   * @param string $needle   <p>
5961 17
   *                         The substring to search for
5962 17
   *                         </p>
5963 17
   * @param int    $offset   [optional] <p>
5964 5
   *                         The offset where to start counting
5965 5
   *                         </p>
5966 5
   * @param int    $length   [optional] <p>
5967
   *                         The maximum length after the specified offset to search for the
5968
   *                         substring. It outputs a warning if the offset plus the length is
5969 20
   *                         greater than the haystack length.
5970
   *                         </p>
5971 18
   *
5972 14
   * @return int This functions returns an integer.
5973 14
   * @since 4.0
5974 14
   * @since 5.0
5975 8
   */
5976 8
  public static function substr_count($haystack, $needle, $offset = 0, $length = null)
5977 8
  {
5978
    $haystack = (string)$haystack;
5979
    $needle = (string)$needle;
5980 19
5981
    if (!isset($haystack[0], $needle[0])) {
5982 9
      return false;
5983 3
    }
5984 3
5985 3
    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...
5986 6
      $offset = (int)$offset;
5987 6
      $length = (int)$length;
5988 6
5989
      if ($length + $offset <= 0) {
5990
        return false;
5991 9
      }
5992 6
5993 6
      $haystack = self::substr($haystack, $offset, $length);
5994 6
    }
5995
5996
    self::checkForSupport();
5997 20
5998
    return \mb_substr_count($haystack, $needle);
5999 2
  }
6000 2
6001
  /**
6002
   * Replace text within a portion of a string.
6003 2
   *
6004 2
   * source: https://gist.github.com/stemar/8287074
6005 2
   *
6006
   * @param string|array   $str
6007
   * @param string|array   $replacement
6008 2
   * @param int|array      $start
6009 18
   * @param null|int|array $length
6010
   *
6011 20
   * @return array|string
6012
   */
6013 20
  public static function substr_replace($str, $replacement, $start, $length = null)
6014
  {
6015
    if (is_array($str)) {
6016 20
      $num = count($str);
6017 20
6018
      // $replacement
6019 3
      if (is_array($replacement)) {
6020 20
        $replacement = array_slice($replacement, 0, $num);
6021
      } else {
6022 20
        $replacement = array_pad(array($replacement), $num, $replacement);
6023
      }
6024
6025 20
      // $start
6026 20 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...
6027 20
        $start = array_slice($start, 0, $num);
6028 2
        foreach ($start as &$valueTmp) {
6029 20
          $valueTmp = (int)$valueTmp === $valueTmp ? $valueTmp : 0;
6030
        }
6031 20
        unset($valueTmp);
6032
      } else {
6033 20
        $start = array_pad(array($start), $num, $start);
6034
      }
6035
6036
      // $length
6037
      if (!isset($length)) {
6038
        $length = array_fill(0, $num, 0);
6039 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...
6040
        $length = array_slice($length, 0, $num);
6041
        foreach ($length as &$valueTmpV2) {
6042
          if (isset($valueTmpV2)) {
6043 2
            $valueTmpV2 = (int)$valueTmpV2 === $valueTmpV2 ? $valueTmpV2 : $num;
6044
          } else {
6045 2
            $valueTmpV2 = 0;
6046
          }
6047 1
        }
6048
        unset($valueTmpV2);
6049 1
      } else {
6050 1
        $length = array_pad(array($length), $num, $length);
6051
      }
6052 1
6053 2
      // Recursive call
6054 2
      return array_map(array(__CLASS__, 'substr_replace'), $str, $replacement, $start, $length);
6055
    } else {
6056
      if (is_array($replacement)) {
6057
        if (count($replacement) > 0) {
6058
          $replacement = $replacement[0];
6059
        } else {
6060
          $replacement = '';
6061
        }
6062
      }
6063
    }
6064
6065
    preg_match_all('/./us', (string)$str, $smatches);
6066
    preg_match_all('/./us', (string)$replacement, $rmatches);
6067
6068
    if ($length === null) {
6069
      self::checkForSupport();
6070
6071
      $length = \mb_strlen($str);
6072
    }
6073 26
6074
    array_splice($smatches[0], $start, $length, $rmatches[0]);
6075 26
6076
    return implode($smatches[0], null);
6077 26
  }
6078 5
6079
  /**
6080
   * Returns a case swapped version of the string.
6081
   *
6082 22
   * @param string $str
6083 6
   * @param string $encoding
6084
   *
6085
   * @return string each character's case swapped
6086 16
   */
6087
  public static function swapCase($str, $encoding = 'UTF-8')
6088
  {
6089
    $str = (string)$str;
6090
6091
    if (!isset($str[0])) {
6092
      return '';
6093
    }
6094
6095
    $encoding = self::normalizeEncoding($encoding);
6096 14
    $str = self::clean($str);
6097
6098 14
    $strSwappedCase = preg_replace_callback(
6099
        '/[\S]/u',
6100
        function ($match) use ($encoding) {
6101
          $marchToUpper = UTF8::strtoupper($match[0], $encoding);
6102
6103
          if ($match[0] === $marchToUpper) {
6104
            return UTF8::strtolower($match[0], $encoding);
6105
          } else {
6106
            return $marchToUpper;
6107
          }
6108
        },
6109
        $str
6110
    );
6111
6112
    return $strSwappedCase;
6113
  }
6114
6115
  /**
6116
   * alias for "UTF8::to_ascii()"
6117
   *
6118
   * @param string $s The input string e.g. a UTF-8 String
6119
   * @param string $subst_chr
6120
   *
6121 8
   * @return string
6122
   */
6123 8
  public static function toAscii($s, $subst_chr = '?')
6124 2
  {
6125
    return self::to_ascii($s, $subst_chr);
6126
  }
6127
6128 7
  /**
6129 7
   * alias for "UTF8::to_latin1()"
6130
   *
6131 7
   * @param $str
6132 1
   *
6133 1
   * @return string
6134 7
   */
6135
  public static function toLatin1($str)
6136
  {
6137 7
    return self::to_latin1($str);
6138
  }
6139 7
6140
  /**
6141
   * alias for "UTF8::to_utf8"
6142
   *
6143 1
   * @param string $str
6144 1
   *
6145 1
   * @return string
6146 7
   */
6147 7
  public static function toUTF8($str)
6148 7
  {
6149 7
    return self::to_utf8($str);
6150 7
  }
6151
6152 7
  /**
6153
   * convert to ASCII
6154
   *
6155
   * @param string $str     The input string.
6156
   * @param string $unknown Character use if character unknown. (default is ?)
6157
   *
6158
   * @return string
6159
   */
6160
  public static function to_ascii($str, $unknown = '?')
6161
  {
6162
    static $UTF8_TO_ASCII;
6163
6164
    // init
6165
    $str = (string)$str;
6166
6167
    if (!isset($str[0])) {
6168
      return '';
6169
    }
6170
6171
    $str = self::clean($str);
6172 1
6173
    self::checkForSupport();
6174 1
    if (self::$support['intl'] === true && Bootup::is_php('5.4')) {
6175
      $str = transliterator_transliterate('Any-Latin; Latin-ASCII;', $str);
6176 1
6177 1
      // check again, if we only have ASCII, now ...
6178
      if (!preg_match("/[\x80-\xFF]/", $str)) {
6179
        return $str;
6180 1
      }
6181
    }
6182 1
6183
    preg_match_all('/.{1}|[^\x00]{1,1}$/us', $str, $ar);
6184 1
    $chars = $ar[0];
6185 1
    foreach ($chars as &$c) {
6186 1
6187 1
      $ordC0 = ord($c[0]);
6188
6189 1
      if ($ordC0 >= 0 && $ordC0 <= 127) {
6190 1
        continue;
6191 1
      }
6192
6193 1
      $ordC1 = ord($c[1]);
6194
6195
      // ASCII - next please
6196
      if ($ordC0 >= 192 && $ordC0 <= 223) {
6197
        $ord = ($ordC0 - 192) * 64 + ($ordC1 - 128);
6198
      }
6199
6200
      if ($ordC0 >= 224) {
6201
        $ordC2 = ord($c[2]);
6202
6203
        if ($ordC0 <= 239) {
6204
          $ord = ($ordC0 - 224) * 4096 + ($ordC1 - 128) * 64 + ($ordC2 - 128);
6205
        }
6206
6207
        if ($ordC0 >= 240) {
6208
          $ordC3 = ord($c[3]);
6209
6210
          if ($ordC0 <= 247) {
6211
            $ord = ($ordC0 - 240) * 262144 + ($ordC1 - 128) * 4096 + ($ordC2 - 128) * 64 + ($ordC3 - 128);
6212
          }
6213
6214
          if ($ordC0 >= 248) {
6215
            $ordC4 = ord($c[4]);
6216
6217 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...
6218
              $ord = ($ordC0 - 248) * 16777216 + ($ordC1 - 128) * 262144 + ($ordC2 - 128) * 4096 + ($ordC3 - 128) * 64 + ($ordC4 - 128);
6219
            }
6220
6221
            if ($ordC0 >= 252) {
6222
              $ordC5 = ord($c[5]);
6223
6224 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...
6225
                $ord = ($ordC0 - 252) * 1073741824 + ($ordC1 - 128) * 16777216 + ($ordC2 - 128) * 262144 + ($ordC3 - 128) * 4096 + ($ordC4 - 128) * 64 + ($ordC5 - 128);
6226
              }
6227
            }
6228
          }
6229
        }
6230
      }
6231
6232
      if ($ordC0 >= 254 && $ordC0 <= 255) {
6233
        $c = $unknown;
6234
        continue;
6235
      }
6236
6237
      if (!isset($ord)) {
6238
        $c = $unknown;
6239
        continue;
6240
      }
6241
6242
      $bank = $ord >> 8;
6243
      if (!array_key_exists($bank, (array)$UTF8_TO_ASCII)) {
6244
        $bankfile = __DIR__ . '/data/' . sprintf('x%02x', $bank) . '.php';
6245
        if (file_exists($bankfile)) {
6246
          /** @noinspection PhpIncludeInspection */
6247
          require $bankfile;
6248
        } else {
6249
          $UTF8_TO_ASCII[$bank] = array();
6250
        }
6251
      }
6252
6253
      $newchar = $ord & 255;
6254
      if (array_key_exists($newchar, $UTF8_TO_ASCII[$bank])) {
6255
        $c = $UTF8_TO_ASCII[$bank][$newchar];
6256
      } else {
6257
        $c = $unknown;
6258
      }
6259
    }
6260
6261
    return implode('', $chars);
6262
  }
6263
6264
  /**
6265
   * alias for "UTF8::to_win1252()"
6266
   *
6267
   * @param   string $str
6268
   *
6269
   * @return  array|string
6270
   */
6271
  public static function to_iso8859($str)
6272
  {
6273
    return self::to_win1252($str);
6274
  }
6275
6276
  /**
6277
   * alias for "UTF8::to_win1252()"
6278
   *
6279
   * @param string|array $str
6280
   *
6281
   * @return string|array
6282
   */
6283
  public static function to_latin1($str)
6284
  {
6285
    return self::to_win1252($str);
6286
  }
6287
6288
  /**
6289
   * This function leaves UTF8 characters alone, while converting almost all non-UTF8 to UTF8.
6290
   *
6291
   * - It assumes that the encoding of the original string is either WINDOWS-1252 or ISO-8859-1.
6292
   *
6293
   * - It may fail to convert characters to UTF-8 if they fall into one of these scenarios:
6294
   *
6295
   * 1) when any of these characters:   ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖרÙÚÛÜÝÞß
6296
   *    are followed by any of these:  ("group B")
6297
   *                                    ¡¢£¤¥¦§¨©ª«¬­®¯°±²³´µ¶•¸¹º»¼½¾¿
6298
   * For example:   %ABREPRESENT%C9%BB. «REPRESENTÉ»
6299
   * The "«" (%AB) character will be converted, but the "É" followed by "»" (%C9%BB)
6300
   * is also a valid unicode character, and will be left unchanged.
6301
   *
6302
   * 2) when any of these: àáâãäåæçèéêëìíîï  are followed by TWO chars from group B,
6303
   * 3) when any of these: ðñòó  are followed by THREE chars from group B.
6304
   *
6305
   * @param string|array $str Any string or array.
6306
   *
6307
   * @return string The same string, but UTF8 encoded.
6308
   */
6309
  public static function to_utf8($str)
6310
  {
6311
    if (is_array($str)) {
6312
      foreach ($str as $k => $v) {
6313
        /** @noinspection AlterInForeachInspection */
6314
        $str[$k] = self::to_utf8($v);
6315
      }
6316
6317
      return $str;
6318
    }
6319
6320
    $str = (string)$str;
6321
6322
    if (!isset($str[0])) {
6323
      return $str;
6324
    }
6325
6326
    $max = strlen($str);
6327
    $buf = '';
6328
6329
    /** @noinspection ForeachInvariantsInspection */
6330
    for ($i = 0; $i < $max; $i++) {
6331
      $c1 = $str[$i];
6332
6333
      if ($c1 >= "\xc0") { // should be converted to UTF8, if it's not UTF8 already
6334
        $c2 = $i + 1 >= $max ? "\x00" : $str[$i + 1];
6335
        $c3 = $i + 2 >= $max ? "\x00" : $str[$i + 2];
6336
        $c4 = $i + 3 >= $max ? "\x00" : $str[$i + 3];
6337
6338
        if ($c1 >= "\xc0" & $c1 <= "\xdf") { // looks like 2 bytes UTF8
6339
6340
          if ($c2 >= "\x80" && $c2 <= "\xbf") { // yeah, almost sure it's UTF8 already
6341
            $buf .= $c1 . $c2;
6342
            $i++;
6343
          } else { // not valid UTF8 - convert it
6344
            $cc1 = (chr(ord($c1) / 64) | "\xc0");
6345
            $cc2 = ($c1 & "\x3f") | "\x80";
6346
            $buf .= $cc1 . $cc2;
6347
          }
6348
6349 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...
6350
6351
          if ($c2 >= "\x80" && $c2 <= "\xbf" && $c3 >= "\x80" && $c3 <= "\xbf") { // yeah, almost sure it's UTF8 already
6352
            $buf .= $c1 . $c2 . $c3;
6353
            $i += 2;
6354
          } else { // not valid UTF8 - convert it
6355
            $cc1 = (chr(ord($c1) / 64) | "\xc0");
6356
            $cc2 = ($c1 & "\x3f") | "\x80";
6357
            $buf .= $cc1 . $cc2;
6358
          }
6359
6360
        } elseif ($c1 >= "\xf0" & $c1 <= "\xf7") { // looks like 4 bytes UTF8
6361
6362 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...
6363
            $buf .= $c1 . $c2 . $c3 . $c4;
6364
            $i += 3;
6365
          } else { // not valid UTF8 - convert it
6366
            $cc1 = (chr(ord($c1) / 64) | "\xc0");
6367
            $cc2 = ($c1 & "\x3f") | "\x80";
6368
            $buf .= $cc1 . $cc2;
6369
          }
6370
6371
        } else { // doesn't look like UTF8, but should be converted
6372
          $cc1 = (chr(ord($c1) / 64) | "\xc0");
6373
          $cc2 = (($c1 & "\x3f") | "\x80");
6374
          $buf .= $cc1 . $cc2;
6375
        }
6376
6377
      } elseif (($c1 & "\xc0") === "\x80") { // needs conversion
6378
6379
        $ordC1 = ord($c1);
6380
        if (isset(self::$win1252ToUtf8[$ordC1])) { // found in Windows-1252 special cases
6381
          $buf .= self::$win1252ToUtf8[$ordC1];
6382
        } else {
6383
          $cc1 = (chr($ordC1 / 64) | "\xc0");
6384
          $cc2 = (($c1 & "\x3f") | "\x80");
6385
          $buf .= $cc1 . $cc2;
6386
        }
6387
6388
      } else { // it doesn't need conversion
6389
        $buf .= $c1;
6390
      }
6391
    }
6392
6393
    self::checkForSupport();
6394
6395
    // decode unicode escape sequences
6396
    $buf = preg_replace_callback(
6397
        '/\\\\u([0-9a-f]{4})/i',
6398
        function ($match) {
6399
          return \mb_convert_encoding(pack('H*', $match[1]), 'UTF-8', 'UCS-2BE');
6400
        },
6401
        $buf
6402
    );
6403
6404
    // decode UTF-8 codepoints
6405
    $buf = preg_replace_callback(
6406
        '/&#\d{2,4};/',
6407
        function ($match) {
6408
          return \mb_convert_encoding($match[0], 'UTF-8', 'HTML-ENTITIES');
6409
        },
6410
        $buf
6411
    );
6412
6413
    return $buf;
6414
  }
6415
6416
  /**
6417
   * Convert a string into "win1252"-encoding.
6418
   *
6419
   * @param  string|array $str
6420
   *
6421
   * @return string|array
6422
   */
6423
  protected static function to_win1252($str)
6424
  {
6425
    if (is_array($str)) {
6426
6427
      foreach ($str as $k => $v) {
6428
        /** @noinspection AlterInForeachInspection */
6429
        $str[$k] = self::to_win1252($v);
6430
      }
6431
6432
      return $str;
6433
    }
6434
6435
    $str = (string)$str;
6436
6437
    if (!isset($str[0])) {
6438
      return '';
6439
    }
6440 6
6441
    return self::utf8_decode($str);
6442 6
  }
6443 6
6444
  /**
6445 6
   * Strip whitespace or other characters from beginning or end of a UTF-8 string.
6446
   *
6447 6
   * INFO: This is slower then "trim()"
6448 5
   *
6449
   * We can only use the original-function, if we use <= 7-Bit in the string / chars
6450
   * but the check for ACSII (7-Bit) cost more time, then we can safe here.
6451
   *
6452 6
   * @param    string $str   The string to be trimmed
6453
   * @param    string $chars Optional characters to be stripped
6454 6
   *
6455
   * @return   string The trimmed string
6456 6
   */
6457 1
  public static function trim($str = '', $chars = INF)
6458 1
  {
6459 1
    $str = (string)$str;
6460
6461 6
    if (!isset($str[0])) {
6462
      return '';
6463
    }
6464
6465
    // Info: http://nadeausoftware.com/articles/2007/9/php_tip_how_strip_punctuation_characters_web_page#Unicodecharactercategories
6466
    if ($chars === INF || !$chars) {
6467
      return preg_replace('/^[\pZ\pC]+|[\pZ\pC]+$/u', '', $str);
6468
    }
6469
6470
    return self::rtrim(self::ltrim($str, $chars), $chars);
6471 6
  }
6472
6473 6
  /**
6474
   * Makes string's first char uppercase.
6475 6
   *
6476 6
   * @param    string $str The input string
6477
   *
6478
   * @return   string The resulting string
6479 5
   */
6480 5
  public static function ucfirst($str)
6481
  {
6482 5
    return self::strtoupper(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::strtoupper() does only seem to accept string, did you maybe forget to handle an error condition?
Loading history...
6483 1
  }
6484 1
6485 1
  /**
6486
   * alias for "UTF8::ucfirst"
6487 5
   *
6488
   * @param $str
6489
   *
6490
   * @return string
6491
   */
6492
  public static function ucword($str)
6493
  {
6494
    return self::ucfirst($str);
6495
  }
6496
6497
  /**
6498
   * Uppercase for all words in the string.
6499
   *
6500
   * @param  string $str
6501
   * @param array   $exceptions
6502
   *
6503
   * @return string
6504
   */
6505
  public static function ucwords($str, $exceptions = array())
6506
  {
6507
    if (!$str) {
6508
      return '';
6509
    }
6510
6511
    // init
6512
    $words = explode(' ', $str);
6513
    $newwords = array();
6514
6515
    if (count($exceptions) > 0) {
6516
      $useExceptions = true;
6517
    } else {
6518
      $useExceptions = false;
6519 1
    }
6520
6521 1
    foreach ($words as $word) {
6522
      if (
6523
          ($useExceptions === false)
6524
          ||
6525
          (
6526
              $useExceptions === true
6527
              &&
6528
              !in_array($word, $exceptions, true)
6529
          )
6530
      ) {
6531
        $word = self::ucfirst($word);
6532
      }
6533 1
      $newwords[] = $word;
6534
    }
6535 1
6536
    return self::ucfirst(implode(' ', $newwords));
6537
  }
6538
6539 1
  /**
6540
   * Multi decode html entity & fix urlencoded-win1252-chars.
6541 1
   *
6542
   * e.g:
6543
   * 'D&#252;sseldorf'               => 'Düsseldorf'
6544 1
   * 'D%FCsseldorf'                  => 'Düsseldorf'
6545 1
   * 'D&#xFC;sseldorf'               => 'Düsseldorf'
6546 1
   * 'D%26%23xFC%3Bsseldorf'         => 'Düsseldorf'
6547 1
   * 'Düsseldorf'                   => 'Düsseldorf'
6548 1
   * 'D%C3%BCsseldorf'               => 'Düsseldorf'
6549
   * 'D%C3%83%C2%BCsseldorf'         => 'Düsseldorf'
6550
   * 'D%25C3%2583%25C2%25BCsseldorf' => 'Düsseldorf'
6551 1
   *
6552
   * @param string $str
6553
   *
6554
   * @return string
6555
   */
6556
  public static function urldecode($str)
6557
  {
6558
    $str = (string)$str;
6559
6560
    if (!isset($str[0])) {
6561
      return '';
6562
    }
6563
6564 4
    $str = preg_replace('/%u([0-9a-f]{3,4})/i', '&#x\\1;', urldecode($str));
6565
6566 4
    $flags = Bootup::is_php('5.4') ? ENT_QUOTES | ENT_HTML5 : ENT_QUOTES;
6567
6568
    $str = self::fix_simple_utf8(
6569
        rawurldecode(
6570 4
            self::html_entity_decode(
6571 4
                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...
6572 4
                $flags
6573
            )
6574 4
        )
6575 4
    );
6576 4
6577 4
    return (string)$str;
6578
  }
6579 4
6580
  /**
6581
   * Return a array with "urlencoded"-win1252 -> UTF-8
6582
   *
6583
   * @return mixed
6584 4
   */
6585
  public static function urldecode_fix_win1252_chars()
6586 4
  {
6587
    static $array = array(
6588
        '%20' => ' ',
6589
        '%21' => '!',
6590
        '%22' => '"',
6591 4
        '%23' => '#',
6592 4
        '%24' => '$',
6593
        '%25' => '%',
6594 4
        '%26' => '&',
6595 4
        '%27' => "'",
6596 4
        '%28' => '(',
6597 4
        '%29' => ')',
6598 4
        '%2A' => '*',
6599
        '%2B' => '+',
6600 4
        '%2C' => ',',
6601 4
        '%2D' => '-',
6602 4
        '%2E' => '.',
6603 4
        '%2F' => '/',
6604
        '%30' => '0',
6605 4
        '%31' => '1',
6606 3
        '%32' => '2',
6607 3
        '%33' => '3',
6608 3
        '%34' => '4',
6609 3
        '%35' => '5',
6610
        '%36' => '6',
6611 3
        '%37' => '7',
6612
        '%38' => '8',
6613
        '%39' => '9',
6614
        '%3A' => ':',
6615 3
        '%3B' => ';',
6616 3
        '%3C' => '<',
6617
        '%3D' => '=',
6618 4
        '%3E' => '>',
6619
        '%3F' => '?',
6620
        '%40' => '@',
6621
        '%41' => 'A',
6622
        '%42' => 'B',
6623
        '%43' => 'C',
6624
        '%44' => 'D',
6625
        '%45' => 'E',
6626
        '%46' => 'F',
6627
        '%47' => 'G',
6628
        '%48' => 'H',
6629
        '%49' => 'I',
6630
        '%4A' => 'J',
6631
        '%4B' => 'K',
6632
        '%4C' => 'L',
6633
        '%4D' => 'M',
6634
        '%4E' => 'N',
6635
        '%4F' => 'O',
6636
        '%50' => 'P',
6637
        '%51' => 'Q',
6638
        '%52' => 'R',
6639
        '%53' => 'S',
6640
        '%54' => 'T',
6641
        '%55' => 'U',
6642
        '%56' => 'V',
6643
        '%57' => 'W',
6644
        '%58' => 'X',
6645
        '%59' => 'Y',
6646
        '%5A' => 'Z',
6647
        '%5B' => '[',
6648
        '%5C' => '\\',
6649
        '%5D' => ']',
6650
        '%5E' => '^',
6651
        '%5F' => '_',
6652
        '%60' => '`',
6653
        '%61' => 'a',
6654
        '%62' => 'b',
6655
        '%63' => 'c',
6656
        '%64' => 'd',
6657
        '%65' => 'e',
6658
        '%66' => 'f',
6659
        '%67' => 'g',
6660
        '%68' => 'h',
6661
        '%69' => 'i',
6662
        '%6A' => 'j',
6663
        '%6B' => 'k',
6664
        '%6C' => 'l',
6665
        '%6D' => 'm',
6666
        '%6E' => 'n',
6667
        '%6F' => 'o',
6668
        '%70' => 'p',
6669
        '%71' => 'q',
6670
        '%72' => 'r',
6671
        '%73' => 's',
6672
        '%74' => 't',
6673
        '%75' => 'u',
6674
        '%76' => 'v',
6675
        '%77' => 'w',
6676
        '%78' => 'x',
6677
        '%79' => 'y',
6678
        '%7A' => 'z',
6679
        '%7B' => '{',
6680
        '%7C' => '|',
6681
        '%7D' => '}',
6682
        '%7E' => '~',
6683
        '%7F' => '',
6684
        '%80' => '`',
6685
        '%81' => '',
6686
        '%82' => '‚',
6687
        '%83' => 'ƒ',
6688
        '%84' => '„',
6689
        '%85' => '…',
6690
        '%86' => '†',
6691
        '%87' => '‡',
6692
        '%88' => 'ˆ',
6693
        '%89' => '‰',
6694
        '%8A' => 'Š',
6695
        '%8B' => '‹',
6696
        '%8C' => 'Œ',
6697
        '%8D' => '',
6698
        '%8E' => 'Ž',
6699
        '%8F' => '',
6700
        '%90' => '',
6701
        '%91' => '‘',
6702
        '%92' => '’',
6703
        '%93' => '“',
6704
        '%94' => '”',
6705
        '%95' => '•',
6706
        '%96' => '–',
6707
        '%97' => '—',
6708
        '%98' => '˜',
6709
        '%99' => '™',
6710
        '%9A' => 'š',
6711
        '%9B' => '›',
6712
        '%9C' => 'œ',
6713
        '%9D' => '',
6714
        '%9E' => 'ž',
6715
        '%9F' => 'Ÿ',
6716
        '%A0' => '',
6717
        '%A1' => '¡',
6718
        '%A2' => '¢',
6719
        '%A3' => '£',
6720
        '%A4' => '¤',
6721
        '%A5' => '¥',
6722
        '%A6' => '¦',
6723
        '%A7' => '§',
6724
        '%A8' => '¨',
6725
        '%A9' => '©',
6726
        '%AA' => 'ª',
6727
        '%AB' => '«',
6728
        '%AC' => '¬',
6729
        '%AD' => '',
6730
        '%AE' => '®',
6731
        '%AF' => '¯',
6732
        '%B0' => '°',
6733
        '%B1' => '±',
6734
        '%B2' => '²',
6735
        '%B3' => '³',
6736
        '%B4' => '´',
6737
        '%B5' => 'µ',
6738
        '%B6' => '¶',
6739
        '%B7' => '·',
6740
        '%B8' => '¸',
6741
        '%B9' => '¹',
6742
        '%BA' => 'º',
6743
        '%BB' => '»',
6744
        '%BC' => '¼',
6745
        '%BD' => '½',
6746
        '%BE' => '¾',
6747
        '%BF' => '¿',
6748
        '%C0' => 'À',
6749
        '%C1' => 'Á',
6750
        '%C2' => 'Â',
6751
        '%C3' => 'Ã',
6752
        '%C4' => 'Ä',
6753
        '%C5' => 'Å',
6754
        '%C6' => 'Æ',
6755
        '%C7' => 'Ç',
6756
        '%C8' => 'È',
6757
        '%C9' => 'É',
6758
        '%CA' => 'Ê',
6759
        '%CB' => 'Ë',
6760
        '%CC' => 'Ì',
6761
        '%CD' => 'Í',
6762
        '%CE' => 'Î',
6763
        '%CF' => 'Ï',
6764
        '%D0' => 'Ð',
6765
        '%D1' => 'Ñ',
6766
        '%D2' => 'Ò',
6767
        '%D3' => 'Ó',
6768
        '%D4' => 'Ô',
6769
        '%D5' => 'Õ',
6770
        '%D6' => 'Ö',
6771
        '%D7' => '×',
6772
        '%D8' => 'Ø',
6773
        '%D9' => 'Ù',
6774
        '%DA' => 'Ú',
6775
        '%DB' => 'Û',
6776
        '%DC' => 'Ü',
6777
        '%DD' => 'Ý',
6778
        '%DE' => 'Þ',
6779
        '%DF' => 'ß',
6780
        '%E0' => 'à',
6781
        '%E1' => 'á',
6782
        '%E2' => 'â',
6783
        '%E3' => 'ã',
6784
        '%E4' => 'ä',
6785
        '%E5' => 'å',
6786
        '%E6' => 'æ',
6787
        '%E7' => 'ç',
6788
        '%E8' => 'è',
6789
        '%E9' => 'é',
6790
        '%EA' => 'ê',
6791
        '%EB' => 'ë',
6792
        '%EC' => 'ì',
6793
        '%ED' => 'í',
6794
        '%EE' => 'î',
6795
        '%EF' => 'ï',
6796
        '%F0' => 'ð',
6797
        '%F1' => 'ñ',
6798
        '%F2' => 'ò',
6799
        '%F3' => 'ó',
6800
        '%F4' => 'ô',
6801
        '%F5' => 'õ',
6802
        '%F6' => 'ö',
6803
        '%F7' => '÷',
6804
        '%F8' => 'ø',
6805
        '%F9' => 'ù',
6806
        '%FA' => 'ú',
6807
        '%FB' => 'û',
6808
        '%FC' => 'ü',
6809
        '%FD' => 'ý',
6810
        '%FE' => 'þ',
6811
        '%FF' => 'ÿ',
6812
    );
6813
6814
    return $array;
6815
  }
6816
6817
  /**
6818
   * Decodes an UTF-8 string to ISO-8859-1.
6819
   *
6820
   * @param string $str
6821
   *
6822
   * @return string
6823
   */
6824
  public static function utf8_decode($str)
6825
  {
6826
    static $utf8ToWin1252Keys = null;
6827
    static $utf8ToWin1252Values = null;
6828
6829
    $str = (string)$str;
6830
6831
    if (!isset($str[0])) {
6832
      return '';
6833
    }
6834
6835
    // init
6836
    self::checkForSupport();
6837
6838
    $str = self::to_utf8($str);
6839
6840
    if ($utf8ToWin1252Keys === null) {
6841
      $utf8ToWin1252Keys = array_keys(self::$utf8ToWin1252);
6842
      $utf8ToWin1252Values = array_values(self::$utf8ToWin1252);
6843
    }
6844
6845
    return Xml::utf8_decode(str_replace($utf8ToWin1252Keys, $utf8ToWin1252Values, $str));
6846
  }
6847
6848
  /**
6849
   * Encodes an ISO-8859-1 string to UTF-8.
6850
   *
6851
   * @param string $str
6852
   *
6853
   * @return string
6854
   */
6855
  public static function utf8_encode($str)
6856
  {
6857
    $str = \utf8_encode($str);
6858
6859
    if (false === strpos($str, "\xC2")) {
6860
      return $str;
6861
    } else {
6862
6863
      static $cp1252ToUtf8Keys = null;
6864
      static $cp1252ToUtf8Values = null;
6865
6866
      if ($cp1252ToUtf8Keys === null) {
6867
        $cp1252ToUtf8Keys = array_keys(self::$cp1252ToUtf8);
6868
        $cp1252ToUtf8Values = array_values(self::$cp1252ToUtf8);
6869
      }
6870
6871
      return str_replace($cp1252ToUtf8Keys, $cp1252ToUtf8Values, $str);
6872
    }
6873
  }
6874
6875
  /**
6876
   * fix -> utf8-win1252 chars
6877
   *
6878
   * If you received an UTF-8 string that was converted from Windows-1252 as it was ISO-8859-1
6879
   * (ignoring Windows-1252 chars from 80 to 9F) use this function to fix it.
6880
   * See: http://en.wikipedia.org/wiki/Windows-1252
6881
   *
6882
   * @deprecated use "UTF8::fix_simple_utf8()"
6883
   *
6884
   * @param   string $str
6885
   *
6886
   * @return  string
6887
   */
6888
  public static function utf8_fix_win1252_chars($str)
6889
  {
6890
    return self::fix_simple_utf8($str);
6891
  }
6892
6893
  /**
6894
   * Returns an array with all utf8 whitespace characters.
6895
   *
6896
   * @see   : http://www.bogofilter.org/pipermail/bogofilter/2003-March/001889.html
6897
   *
6898
   * @author: Derek E. [email protected]
6899
   *
6900
   * @return array an array with all known whitespace characters as values and the type of whitespace as keys
6901
   *         as defined in above URL
6902
   */
6903
  public static function whitespace_table()
6904
  {
6905
    return self::$whitespaceTable;
6906
  }
6907
6908
  /**
6909
   * Limit the number of words in a string.
6910
   *
6911
   * @param  string $str
6912
   * @param  int    $words
6913
   * @param  string $strAddOn
6914
   *
6915
   * @return string
6916
   */
6917
  public static function words_limit($str, $words = 100, $strAddOn = '...')
6918
  {
6919
    $str = (string)$str;
6920
6921
    if (!isset($str[0])) {
6922
      return '';
6923
    }
6924
6925
    $words = (int)$words;
6926
6927
    if ($words < 1) {
6928
      return '';
6929
    }
6930
6931
    preg_match('/^\s*+(?:\S++\s*+){1,' . $words . '}/u', $str, $matches);
6932
6933
    if (
6934
        !isset($matches[0])
6935
        ||
6936
        self::strlen($str) === self::strlen($matches[0])
6937
    ) {
6938
      return $str;
6939
    }
6940
6941
    return self::rtrim($matches[0]) . $strAddOn;
6942
  }
6943
6944
  /**
6945
   * Wraps a string to a given number of characters
6946
   *
6947
   * @link  http://php.net/manual/en/function.wordwrap.php
6948
   *
6949
   * @param string $str   <p>
6950
   *                      The input string.
6951
   *                      </p>
6952
   * @param int    $width [optional] <p>
6953
   *                      The column width.
6954
   *                      </p>
6955
   * @param string $break [optional] <p>
6956
   *                      The line is broken using the optional
6957
   *                      break parameter.
6958
   *                      </p>
6959
   * @param bool   $cut   [optional] <p>
6960
   *                      If the cut is set to true, the string is
6961
   *                      always wrapped at or before the specified width. So if you have
6962
   *                      a word that is larger than the given width, it is broken apart.
6963
   *                      (See second example).
6964
   *                      </p>
6965
   *
6966
   * @return string the given string wrapped at the specified column.
6967
   * @since 4.0.2
6968
   * @since 5.0
6969
   */
6970
  public static function wordwrap($str, $width = 75, $break = "\n", $cut = false)
6971
  {
6972
    $str = (string)$str;
6973
    $break = (string)$break;
6974
6975
    if (!isset($str[0], $break[0])) {
6976
      return '';
6977
    }
6978
6979
    $w = '';
6980
    $strSplit = explode($break, $str);
6981
    $count = count($strSplit);
6982
6983
    if (1 === $count && '' === $strSplit[0]) {
6984
      return '';
6985
    }
6986
6987
    $chars = array();
6988
    /** @noinspection ForeachInvariantsInspection */
6989
    for ($i = 0; $i < $count; ++$i) {
6990
6991
      if ($i) {
6992
        $chars[] = $break;
6993
        $w .= '#';
6994
      }
6995
6996
      $c = $strSplit[$i];
6997
      unset($strSplit[$i]);
6998
6999
      foreach (self::split($c) as $c) {
7000
        $chars[] = $c;
7001
        $w .= ' ' === $c ? ' ' : '?';
7002
      }
7003
    }
7004
7005
    $strReturn = '';
7006
    $j = 0;
7007
    $b = $i = -1;
7008
    $w = wordwrap($w, $width, '#', $cut);
7009
7010
    while (false !== $b = self::strpos($w, '#', $b + 1)) {
7011
      for (++$i; $i < $b; ++$i) {
7012
        $strReturn .= $chars[$j];
7013
        unset($chars[$j++]);
7014
      }
7015
7016
      if ($break === $chars[$j] || ' ' === $chars[$j]) {
7017
        unset($chars[$j++]);
7018
      }
7019
7020
      $strReturn .= $break;
7021
    }
7022
7023
    return $strReturn . implode('', $chars);
7024
  }
7025
7026
  /**
7027
   * Returns an array of Unicode White Space characters.
7028
   *
7029
   * @return   array An array with numeric code point as key and White Space Character as value.
7030
   */
7031
  public static function ws()
7032
  {
7033
    return self::$whitespace;
7034
  }
7035
7036
}
7037