Completed
Push — master ( b6a1cd...3a6488 )
by Lars
03:10
created

UTF8::strlen()   C

Complexity

Conditions 8
Paths 9

Size

Total Lines 30
Code Lines 18

Duplication

Lines 9
Ratio 30 %

Code Coverage

Tests 3
CRAP Score 8

Importance

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

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

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

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

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

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

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

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

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

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

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

Loading history...
1426 3
        foreach ($var as $k => $v) {
1427 3
          /** @noinspection AlterInForeachInspection */
1428 9
          $var[$k] = self::filter($v, $normalization_form, $leading_combining);
1429 2
        }
1430 2
        break;
1431 2 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...
1432 2
        foreach ($var as $k => $v) {
1433 9
          $var->{$k} = self::filter($v, $normalization_form, $leading_combining);
1434
        }
1435 8
        break;
1436
      case 'string':
0 ignored issues
show
Coding Style introduced by
The case body in a switch statement must start on the line following the statement.

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

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

    doSomethingElse(); //wrong
    break;

}

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

Loading history...
1437 2
1438 2
        if (false !== strpos($var, "\r")) {
1439
          // Workaround https://bugs.php.net/65732
1440 8
          $var = str_replace(array("\r\n", "\r"), "\n", $var);
1441
        }
1442 8
1443 6
        if (self::is_ascii($var) === false) {
1444 6
1445 6
          /** @noinspection PhpUndefinedClassInspection */
1446
          if (\Normalizer::isNormalized($var, $normalization_form)) {
1447 6
            $n = '-';
1448 3
          } else {
1449 3
            /** @noinspection PhpUndefinedClassInspection */
1450 5
            $n = \Normalizer::normalize($var, $normalization_form);
1451
1452
            if (isset($n[0])) {
1453
              $var = $n;
1454
            } else {
1455 8
              $var = self::encode('UTF-8', $var);
1456 8
            }
1457 5
          }
1458 8
1459
          if (
1460
              $var[0] >= "\x80" && isset($n[0], $leading_combining[0])
1461 2
              &&
1462 2
              preg_match('/^\p{Mn}/u', $var)
1463 8
          ) {
1464 8
            // Prevent leading combining chars
1465 9
            // for NFC-safe concatenations.
1466
            $var = $leading_combining . $var;
1467 9
          }
1468
        }
1469
        break;
1470
    }
1471
1472
    return $var;
1473
  }
1474
1475
  /**
1476
   * "filter_input()"-wrapper with normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
1477
   *
1478
   * @param int    $type
1479
   * @param string $var
1480
   * @param int    $filter
1481
   * @param mixed  $option
1482
   *
1483
   * @return mixed
1484
   */
1485 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...
1486
  {
1487
    if (4 > func_num_args()) {
1488
      $var = filter_input($type, $var, $filter);
1489
    } else {
1490
      $var = filter_input($type, $var, $filter, $option);
1491
    }
1492
1493
    return self::filter($var);
1494
  }
1495
1496
  /**
1497
   * "filter_input_array()"-wrapper with normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
1498
   *
1499
   * @param int   $type
1500
   * @param mixed $definition
1501
   * @param bool  $add_empty
1502
   *
1503
   * @return mixed
1504
   */
1505 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...
1506
  {
1507
    if (2 > func_num_args()) {
1508
      $a = filter_input_array($type);
1509
    } else {
1510
      $a = filter_input_array($type, $definition, $add_empty);
1511
    }
1512
1513
    return self::filter($a);
1514
  }
1515
1516
  /**
1517
   * "filter_var()"-wrapper with normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
1518
   *
1519
   * @param mixed $var
1520 1
   * @param int   $filter
1521
   * @param mixed $option
1522 1
   *
1523 1
   * @return mixed
1524 1
   */
1525 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...
1526
  {
1527
    if (3 > func_num_args()) {
1528 1
      $var = filter_var($var, $filter);
1529
    } else {
1530
      $var = filter_var($var, $filter, $option);
1531
    }
1532
1533
    return self::filter($var);
1534
  }
1535
1536
  /**
1537
   * "filter_var_array()"-wrapper with normalizes to UTF-8 NFC, converting from WINDOWS-1252 when needed.
1538
   *
1539
   * @param array $data
1540 1
   * @param mixed $definition
1541
   * @param bool  $add_empty
1542 1
   *
1543 1
   * @return mixed
1544 1
   */
1545 1 View Code Duplication
  public static function filter_var_array($data, $definition = null, $add_empty = true)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

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

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

Loading history...
1546
  {
1547
    if (2 > func_num_args()) {
1548 1
      $a = filter_var_array($data);
1549
    } else {
1550
      $a = filter_var_array($data, $definition, $add_empty);
1551
    }
1552
1553
    return self::filter($a);
1554
  }
1555
1556
  /**
1557
   * Check if the number of unicode characters are not more than the specified integer.
1558
   *
1559 1
   * @param string $str      The original string to be checked.
1560
   * @param int    $box_size The size in number of chars to be checked against string.
1561 1
   *
1562
   * @return bool true if string is less than or equal to $box_size, false otherwise.
1563
   */
1564
  public static function fits_inside($str, $box_size)
1565
  {
1566
    return (self::strlen($str) <= $box_size);
1567
  }
1568
1569
  /**
1570
   * Try to fix simple broken UTF-8 strings.
1571
   *
1572
   * INFO: Take a look at "UTF8::fix_utf8()" if you need a more advanced fix for broken UTF-8 strings.
1573
   *
1574
   * If you received an UTF-8 string that was converted from Windows-1252 as it was ISO-8859-1
1575
   * (ignoring Windows-1252 chars from 80 to 9F) use this function to fix it.
1576
   * See: http://en.wikipedia.org/wiki/Windows-1252
1577 7
   *
1578
   * @param string $str <p>The input string</p>
1579 7
   *
1580 7
   * @return string
1581
   */
1582 7 View Code Duplication
  public static function fix_simple_utf8($str)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

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

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

Loading history...
1583
  {
1584 7
    // init
1585 2
    $str = (string)$str;
1586
1587
    if (!isset($str[0])) {
1588 7
      return '';
1589 1
    }
1590 1
1591 1
    static $brokenUtf8ToUtf8Keys = null;
1592
    static $brokenUtf8ToUtf8Values = null;
1593 7
1594
    if ($brokenUtf8ToUtf8Keys === null) {
1595
      $brokenUtf8ToUtf8Keys = array_keys(self::$brokenUtf8ToUtf8);
1596
      $brokenUtf8ToUtf8Values = array_values(self::$brokenUtf8ToUtf8);
1597
    }
1598
1599
    return str_replace($brokenUtf8ToUtf8Keys, $brokenUtf8ToUtf8Values, $str);
1600
  }
1601
1602
  /**
1603 1
   * Fix a double (or multiple) encoded UTF8 string.
1604
   *
1605 1
   * @param string|string[] $str <p>You can use a string or an array of strings.</p>
1606
   *
1607 1
   * @return mixed
1608
   */
1609
  public static function fix_utf8($str)
1610 1
  {
1611 1
    if (is_array($str)) {
1612
1613 1
      /** @noinspection ForeachSourceInspection */
1614
      foreach ($str as $k => $v) {
1615
        /** @noinspection AlterInForeachInspection */
1616 1
        /** @noinspection OffsetOperationsInspection */
1617 1
        $str[$k] = self::fix_utf8($v);
1618 1
      }
1619 1
1620 1
      return $str;
1621
    }
1622 1
1623
    $last = '';
1624
    while ($last !== $str) {
1625
      $last = $str;
1626
      $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 1626 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...
1627
    }
1628
1629
    return $str;
1630
  }
1631
1632 1
  /**
1633
   * Get character of a specific character.
1634 1
   *
1635
   * @param string $char
1636
   *
1637
   * @return string <p>'RTL' or 'LTR'</p>
1638 1
   */
1639
  public static function getCharDirection($char)
1640
  {
1641
    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
1642
      self::checkForSupport();
1643
    }
1644
1645
    if (self::$support['intlChar'] === true) {
1646
      $tmpReturn = \IntlChar::charDirection($char);
1647
1648
      // from "IntlChar"-Class
1649
      $charDirection = array(
1650
          'RTL' => array(1, 13, 14, 15, 21),
1651
          'LTR' => array(0, 11, 12, 20),
1652
      );
1653
1654 1
      if (in_array($tmpReturn, $charDirection['LTR'], true)) {
1655
        return 'LTR';
1656 1
      } elseif (in_array($tmpReturn, $charDirection['RTL'], true)) {
1657 1
        return 'RTL';
1658
      }
1659
    }
1660 1
1661
    $c = static::chr_to_decimal($char);
1662 1
1663 1
    if (!(0x5be <= $c && 0x10b7f >= $c)) {
1664 1
      return 'LTR';
1665 1
    }
1666 1
1667 1
    if (0x85e >= $c) {
1668 1
1669 1
      if (0x5be === $c ||
1670 1
          0x5c0 === $c ||
1671 1
          0x5c3 === $c ||
1672 1
          0x5c6 === $c ||
1673
          (0x5d0 <= $c && 0x5ea >= $c) ||
1674
          (0x5f0 <= $c && 0x5f4 >= $c) ||
1675
          0x608 === $c ||
1676
          0x60b === $c ||
1677
          0x60d === $c ||
1678
          0x61b === $c ||
1679
          (0x61e <= $c && 0x64a >= $c) ||
1680
          (0x66d <= $c && 0x66f >= $c) ||
1681
          (0x671 <= $c && 0x6d5 >= $c) ||
1682
          (0x6e5 <= $c && 0x6e6 >= $c) ||
1683
          (0x6ee <= $c && 0x6ef >= $c) ||
1684
          (0x6fa <= $c && 0x70d >= $c) ||
1685
          0x710 === $c ||
1686
          (0x712 <= $c && 0x72f >= $c) ||
1687
          (0x74d <= $c && 0x7a5 >= $c) ||
1688
          0x7b1 === $c ||
1689
          (0x7c0 <= $c && 0x7ea >= $c) ||
1690
          (0x7f4 <= $c && 0x7f5 >= $c) ||
1691
          0x7fa === $c ||
1692 1
          (0x800 <= $c && 0x815 >= $c) ||
1693 1
          0x81a === $c ||
1694
          0x824 === $c ||
1695
          0x828 === $c ||
1696
          (0x830 <= $c && 0x83e >= $c) ||
1697
          (0x840 <= $c && 0x858 >= $c) ||
1698
          0x85e === $c
1699
      ) {
1700
        return 'RTL';
1701
      }
1702
1703
    } elseif (0x200f === $c) {
1704
1705
      return 'RTL';
1706
1707
    } elseif (0xfb1d <= $c) {
1708
1709
      if (0xfb1d === $c ||
1710
          (0xfb1f <= $c && 0xfb28 >= $c) ||
1711
          (0xfb2a <= $c && 0xfb36 >= $c) ||
1712
          (0xfb38 <= $c && 0xfb3c >= $c) ||
1713
          0xfb3e === $c ||
1714
          (0xfb40 <= $c && 0xfb41 >= $c) ||
1715
          (0xfb43 <= $c && 0xfb44 >= $c) ||
1716
          (0xfb46 <= $c && 0xfbc1 >= $c) ||
1717
          (0xfbd3 <= $c && 0xfd3d >= $c) ||
1718
          (0xfd50 <= $c && 0xfd8f >= $c) ||
1719
          (0xfd92 <= $c && 0xfdc7 >= $c) ||
1720
          (0xfdf0 <= $c && 0xfdfc >= $c) ||
1721
          (0xfe70 <= $c && 0xfe74 >= $c) ||
1722
          (0xfe76 <= $c && 0xfefc >= $c) ||
1723
          (0x10800 <= $c && 0x10805 >= $c) ||
1724
          0x10808 === $c ||
1725
          (0x1080a <= $c && 0x10835 >= $c) ||
1726
          (0x10837 <= $c && 0x10838 >= $c) ||
1727
          0x1083c === $c ||
1728
          (0x1083f <= $c && 0x10855 >= $c) ||
1729
          (0x10857 <= $c && 0x1085f >= $c) ||
1730
          (0x10900 <= $c && 0x1091b >= $c) ||
1731
          (0x10920 <= $c && 0x10939 >= $c) ||
1732
          0x1093f === $c ||
1733
          0x10a00 === $c ||
1734
          (0x10a10 <= $c && 0x10a13 >= $c) ||
1735
          (0x10a15 <= $c && 0x10a17 >= $c) ||
1736
          (0x10a19 <= $c && 0x10a33 >= $c) ||
1737
          (0x10a40 <= $c && 0x10a47 >= $c) ||
1738
          (0x10a50 <= $c && 0x10a58 >= $c) ||
1739
          (0x10a60 <= $c && 0x10a7f >= $c) ||
1740
          (0x10b00 <= $c && 0x10b35 >= $c) ||
1741
          (0x10b40 <= $c && 0x10b55 >= $c) ||
1742
          (0x10b58 <= $c && 0x10b72 >= $c) ||
1743
          (0x10b78 <= $c && 0x10b7f >= $c)
1744
      ) {
1745
        return 'RTL';
1746
      }
1747
    }
1748
1749
    return 'LTR';
1750
  }
1751
1752 1
  /**
1753
   * get data from "/data/*.ser"
1754 1
   *
1755 1
   * @param string $file
1756
   *
1757 1
   * @return bool|string|array|int <p>Will return false on error.</p>
1758
   */
1759
  private static function getData($file)
1760
  {
1761
    $file = __DIR__ . '/data/' . $file . '.php';
1762
    if (file_exists($file)) {
1763
      /** @noinspection PhpIncludeInspection */
1764
      return require $file;
1765
    } else {
1766
      return false;
1767
    }
1768
  }
1769
1770
  /**
1771
   * alias for "UTF8::string_has_bom()"
1772 1
   *
1773
   * @see UTF8::string_has_bom()
1774 1
   *
1775
   * @param string $str
1776
   *
1777
   * @return bool
1778
   */
1779
  public static function hasBom($str)
1780
  {
1781
    return self::string_has_bom($str);
1782
  }
1783
1784
  /**
1785
   * Converts hexadecimal U+xxxx code point representation to integer.
1786 1
   *
1787
   * INFO: opposite to UTF8::int_to_hex()
1788 1
   *
1789 1
   * @param string $str <p>The hexadecimal code point representation.</p>
1790
   *
1791
   * @return int|false <p>The code point, or false on failure.</p>
1792 1
   */
1793 1
  public static function hex_to_int($str)
1794
  {
1795
    if (!$str) {
1796 1
      return false;
1797
    }
1798
1799
    if (preg_match('/^(?:\\\u|U\+|)([a-z0-9]{4,6})$/i', $str, $match)) {
1800
      return intval($match[1], 16);
1801
    }
1802
1803
    return false;
1804
  }
1805
1806
  /**
1807
   * alias for "UTF8::html_entity_decode()"
1808
   *
1809
   * @see UTF8::html_entity_decode()
1810 1
   *
1811
   * @param string $str
1812 1
   * @param int    $flags
1813
   * @param string $encoding
1814
   *
1815
   * @return string
1816
   */
1817
  public static function html_decode($str, $flags = null, $encoding = 'UTF-8')
1818
  {
1819
    return self::html_entity_decode($str, $flags, $encoding);
1820
  }
1821
1822
  /**
1823
   * Converts a UTF-8 string to a series of HTML numbered entities.
1824
   *
1825
   * INFO: opposite to UTF8::html_decode()
1826 2
   *
1827
   * @param string $str            <p>The Unicode string to be encoded as numbered entities.</p>
1828
   * @param bool   $keepAsciiChars [optional] <p>Keep ASCII chars.</p>
1829 2
   * @param string $encoding       [optional] <p>Default is UTF-8</p>
1830
   *
1831 2
   * @return string <p>HTML numbered entities.</p>
1832 2
   */
1833 1
  public static function html_encode($str, $keepAsciiChars = false, $encoding = 'UTF-8')
1834 1
  {
1835
    # INFO: http://stackoverflow.com/questions/35854535/better-explanation-of-convmap-in-mb-encode-numericentity
1836 2
    if (function_exists('mb_encode_numericentity')) {
1837 1
1838 1
      $startCode = 0x00;
1839
      if ($keepAsciiChars === true) {
1840 2
        $startCode = 0x80;
1841 2
      }
1842 2
1843
      if ($encoding !== 'UTF-8') {
1844 2
        $encoding = self::normalize_encoding($encoding);
1845
      }
1846
1847
      return mb_encode_numericentity(
1848
          $str,
1849
          array($startCode, 0xffff, 0, 0xffff,),
1850
          $encoding
1851
      );
1852
    }
1853
1854
    return implode(
1855
        array_map(
1856
            function ($data) use ($keepAsciiChars) {
1857
              return UTF8::single_chr_html_encode($data, $keepAsciiChars);
1858
            },
1859
            self::split($str)
1860
        )
1861
    );
1862
  }
1863
1864
  /**
1865
   * UTF-8 version of html_entity_decode()
1866
   *
1867
   * The reason we are not using html_entity_decode() by itself is because
1868
   * while it is not technically correct to leave out the semicolon
1869
   * at the end of an entity most browsers will still interpret the entity
1870
   * correctly. html_entity_decode() does not convert entities without
1871
   * semicolons, so we are left with our own little solution here. Bummer.
1872
   *
1873
   * Convert all HTML entities to their applicable characters
1874
   *
1875
   * INFO: opposite to UTF8::html_encode()
1876
   *
1877
   * @link http://php.net/manual/en/function.html-entity-decode.php
1878
   *
1879
   * @param string $str      <p>
1880
   *                         The input string.
1881
   *                         </p>
1882
   * @param int    $flags    [optional] <p>
1883
   *                         A bitmask of one or more of the following flags, which specify how to handle quotes and
1884
   *                         which document type to use. The default is ENT_COMPAT | ENT_HTML401.
1885
   *                         <table>
1886
   *                         Available <i>flags</i> constants
1887
   *                         <tr valign="top">
1888
   *                         <td>Constant Name</td>
1889
   *                         <td>Description</td>
1890
   *                         </tr>
1891
   *                         <tr valign="top">
1892
   *                         <td><b>ENT_COMPAT</b></td>
1893
   *                         <td>Will convert double-quotes and leave single-quotes alone.</td>
1894
   *                         </tr>
1895
   *                         <tr valign="top">
1896
   *                         <td><b>ENT_QUOTES</b></td>
1897
   *                         <td>Will convert both double and single quotes.</td>
1898
   *                         </tr>
1899
   *                         <tr valign="top">
1900
   *                         <td><b>ENT_NOQUOTES</b></td>
1901
   *                         <td>Will leave both double and single quotes unconverted.</td>
1902
   *                         </tr>
1903
   *                         <tr valign="top">
1904
   *                         <td><b>ENT_HTML401</b></td>
1905
   *                         <td>
1906
   *                         Handle code as HTML 4.01.
1907
   *                         </td>
1908
   *                         </tr>
1909
   *                         <tr valign="top">
1910
   *                         <td><b>ENT_XML1</b></td>
1911
   *                         <td>
1912
   *                         Handle code as XML 1.
1913
   *                         </td>
1914
   *                         </tr>
1915
   *                         <tr valign="top">
1916
   *                         <td><b>ENT_XHTML</b></td>
1917
   *                         <td>
1918
   *                         Handle code as XHTML.
1919
   *                         </td>
1920
   *                         </tr>
1921
   *                         <tr valign="top">
1922
   *                         <td><b>ENT_HTML5</b></td>
1923
   *                         <td>
1924
   *                         Handle code as HTML 5.
1925
   *                         </td>
1926 9
   *                         </tr>
1927
   *                         </table>
1928 9
   *                         </p>
1929
   * @param string $encoding [optional] <p>Encoding to use.</p>
1930 9
   *
1931 6
   * @return string <p>The decoded string.</p>
1932
   */
1933
  public static function html_entity_decode($str, $flags = null, $encoding = 'UTF-8')
1934 9
  {
1935 7
    $str = (string)$str;
1936
1937
    if (!isset($str[0])) {
1938
      return '';
1939 9
    }
1940 9
1941
    if (!isset($str[3])) { // examples: &; || &x;
0 ignored issues
show
Unused Code Comprehensibility introduced by
46% of this comment could be valid code. Did you maybe forget this after debugging?

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

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

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

Loading history...
1942 9
      return $str;
1943 9
    }
1944 9
1945 9
    if (
1946 9
        strpos($str, '&') === false
1947 6
        ||
1948
        (
1949
            strpos($str, '&#') === false
1950 9
            &&
1951 2
            strpos($str, ';') === false
1952 2
        )
1953
    ) {
1954 9
      return $str;
1955 4
    }
1956 4
1957 4
    if ($encoding !== 'UTF-8') {
1958
      $encoding = self::normalize_encoding($encoding);
1959
    }
1960 4
1961
    if ($flags === null) {
1962
      if (Bootup::is_php('5.4') === true) {
1963 9
        $flags = ENT_COMPAT | ENT_HTML5;
1964
      } else {
1965 9
        $flags = ENT_COMPAT;
1966 9
      }
1967
    }
1968 7
1969
    do {
1970 7
      $str_compare = $str;
1971 6
1972
      $str = preg_replace_callback(
1973 4
          "/&#\d{2,5};/",
1974
          function ($matches) use ($encoding) {
1975 9
            $returnTmp = \mb_convert_encoding($matches[0], $encoding, 'HTML-ENTITIES');
1976
1977 9
            if ($returnTmp !== '"' && $returnTmp !== "'") {
1978
              return $returnTmp;
1979
            } else {
1980 9
              return $matches[0];
1981 9
            }
1982 9
          },
1983
          $str
1984 9
      );
1985
1986 9
      // decode numeric & UTF16 two byte entities
1987
      $str = html_entity_decode(
1988 9
          preg_replace('/(&#(?:x0*[0-9a-f]{2,5}(?![0-9a-f;])|(?:0*\d{2,4}(?![0-9;]))))/iS', '$1;', $str),
1989
          $flags,
1990
          $encoding
1991
      );
1992
1993
    } while ($str_compare !== $str);
1994
1995
    return $str;
1996
  }
1997
1998
  /**
1999
   * Convert all applicable characters to HTML entities: UTF-8 version of htmlentities()
2000
   *
2001
   * @link http://php.net/manual/en/function.htmlentities.php
2002
   *
2003
   * @param string $str           <p>
2004
   *                              The input string.
2005
   *                              </p>
2006
   * @param int    $flags         [optional] <p>
2007
   *                              A bitmask of one or more of the following flags, which specify how to handle quotes,
2008
   *                              invalid code unit sequences and the used document type. The default is
2009
   *                              ENT_COMPAT | ENT_HTML401.
2010
   *                              <table>
2011
   *                              Available <i>flags</i> constants
2012
   *                              <tr valign="top">
2013
   *                              <td>Constant Name</td>
2014
   *                              <td>Description</td>
2015
   *                              </tr>
2016
   *                              <tr valign="top">
2017
   *                              <td><b>ENT_COMPAT</b></td>
2018
   *                              <td>Will convert double-quotes and leave single-quotes alone.</td>
2019
   *                              </tr>
2020
   *                              <tr valign="top">
2021
   *                              <td><b>ENT_QUOTES</b></td>
2022
   *                              <td>Will convert both double and single quotes.</td>
2023
   *                              </tr>
2024
   *                              <tr valign="top">
2025
   *                              <td><b>ENT_NOQUOTES</b></td>
2026
   *                              <td>Will leave both double and single quotes unconverted.</td>
2027
   *                              </tr>
2028
   *                              <tr valign="top">
2029
   *                              <td><b>ENT_IGNORE</b></td>
2030
   *                              <td>
2031
   *                              Silently discard invalid code unit sequences instead of returning
2032
   *                              an empty string. Using this flag is discouraged as it
2033
   *                              may have security implications.
2034
   *                              </td>
2035
   *                              </tr>
2036
   *                              <tr valign="top">
2037
   *                              <td><b>ENT_SUBSTITUTE</b></td>
2038
   *                              <td>
2039
   *                              Replace invalid code unit sequences with a Unicode Replacement Character
2040
   *                              U+FFFD (UTF-8) or &#38;#38;#FFFD; (otherwise) instead of returning an empty string.
2041
   *                              </td>
2042
   *                              </tr>
2043
   *                              <tr valign="top">
2044
   *                              <td><b>ENT_DISALLOWED</b></td>
2045
   *                              <td>
2046
   *                              Replace invalid code points for the given document type with a
2047
   *                              Unicode Replacement Character U+FFFD (UTF-8) or &#38;#38;#FFFD;
2048
   *                              (otherwise) instead of leaving them as is. This may be useful, for
2049
   *                              instance, to ensure the well-formedness of XML documents with
2050
   *                              embedded external content.
2051
   *                              </td>
2052
   *                              </tr>
2053
   *                              <tr valign="top">
2054
   *                              <td><b>ENT_HTML401</b></td>
2055
   *                              <td>
2056
   *                              Handle code as HTML 4.01.
2057
   *                              </td>
2058
   *                              </tr>
2059
   *                              <tr valign="top">
2060
   *                              <td><b>ENT_XML1</b></td>
2061
   *                              <td>
2062
   *                              Handle code as XML 1.
2063
   *                              </td>
2064
   *                              </tr>
2065
   *                              <tr valign="top">
2066
   *                              <td><b>ENT_XHTML</b></td>
2067
   *                              <td>
2068
   *                              Handle code as XHTML.
2069
   *                              </td>
2070
   *                              </tr>
2071
   *                              <tr valign="top">
2072
   *                              <td><b>ENT_HTML5</b></td>
2073
   *                              <td>
2074
   *                              Handle code as HTML 5.
2075
   *                              </td>
2076
   *                              </tr>
2077
   *                              </table>
2078
   *                              </p>
2079
   * @param string $encoding      [optional] <p>
2080
   *                              Like <b>htmlspecialchars</b>,
2081
   *                              <b>htmlentities</b> takes an optional third argument
2082
   *                              <i>encoding</i> which defines encoding used in
2083
   *                              conversion.
2084
   *                              Although this argument is technically optional, you are highly
2085
   *                              encouraged to specify the correct value for your code.
2086
   *                              </p>
2087
   * @param bool   $double_encode [optional] <p>
2088
   *                              When <i>double_encode</i> is turned off PHP will not
2089
   *                              encode existing html entities. The default is to convert everything.
2090
   *                              </p>
2091
   *
2092
   *
2093
   * @return string the encoded string.
2094 2
   * </p>
2095
   * <p>
2096 2
   * If the input <i>string</i> contains an invalid code unit
2097 1
   * sequence within the given <i>encoding</i> an empty string
2098 1
   * will be returned, unless either the <b>ENT_IGNORE</b> or
2099
   * <b>ENT_SUBSTITUTE</b> flags are set.
2100 2
   */
2101
  public static function htmlentities($str, $flags = ENT_COMPAT, $encoding = 'UTF-8', $double_encode = true)
2102 2
  {
2103 1
    if ($encoding !== 'UTF-8') {
2104
      $encoding = self::normalize_encoding($encoding);
2105
    }
2106 2
2107 2
    $str = htmlentities($str, $flags, $encoding, $double_encode);
2108 2
2109 2
    if ($encoding !== 'UTF-8') {
2110 2
      return $str;
2111 1
    }
2112
2113 1
    $byteLengths = self::chr_size_list($str);
2114 1
    $search = array();
2115 1
    $replacements = array();
2116 1
    foreach ($byteLengths as $counter => $byteLength) {
2117 1
      if ($byteLength >= 3) {
2118 2
        $char = self::access($str, $counter);
2119
2120 2
        if (!isset($replacements[$char])) {
2121
          $search[$char] = $char;
2122
          $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 2118 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...
2123
        }
2124
      }
2125
    }
2126
2127
    return str_replace($search, $replacements, $str);
2128
  }
2129
2130
  /**
2131
   * Convert only special characters to HTML entities: UTF-8 version of htmlspecialchars()
2132
   *
2133
   * INFO: Take a look at "UTF8::htmlentities()"
2134
   *
2135
   * @link http://php.net/manual/en/function.htmlspecialchars.php
2136
   *
2137
   * @param string $str           <p>
2138
   *                              The string being converted.
2139
   *                              </p>
2140
   * @param int    $flags         [optional] <p>
2141
   *                              A bitmask of one or more of the following flags, which specify how to handle quotes,
2142
   *                              invalid code unit sequences and the used document type. The default is
2143
   *                              ENT_COMPAT | ENT_HTML401.
2144
   *                              <table>
2145
   *                              Available <i>flags</i> constants
2146
   *                              <tr valign="top">
2147
   *                              <td>Constant Name</td>
2148
   *                              <td>Description</td>
2149
   *                              </tr>
2150
   *                              <tr valign="top">
2151
   *                              <td><b>ENT_COMPAT</b></td>
2152
   *                              <td>Will convert double-quotes and leave single-quotes alone.</td>
2153
   *                              </tr>
2154
   *                              <tr valign="top">
2155
   *                              <td><b>ENT_QUOTES</b></td>
2156
   *                              <td>Will convert both double and single quotes.</td>
2157
   *                              </tr>
2158
   *                              <tr valign="top">
2159
   *                              <td><b>ENT_NOQUOTES</b></td>
2160
   *                              <td>Will leave both double and single quotes unconverted.</td>
2161
   *                              </tr>
2162
   *                              <tr valign="top">
2163
   *                              <td><b>ENT_IGNORE</b></td>
2164
   *                              <td>
2165
   *                              Silently discard invalid code unit sequences instead of returning
2166
   *                              an empty string. Using this flag is discouraged as it
2167
   *                              may have security implications.
2168
   *                              </td>
2169
   *                              </tr>
2170
   *                              <tr valign="top">
2171
   *                              <td><b>ENT_SUBSTITUTE</b></td>
2172
   *                              <td>
2173
   *                              Replace invalid code unit sequences with a Unicode Replacement Character
2174
   *                              U+FFFD (UTF-8) or &#38;#38;#FFFD; (otherwise) instead of returning an empty string.
2175
   *                              </td>
2176
   *                              </tr>
2177
   *                              <tr valign="top">
2178
   *                              <td><b>ENT_DISALLOWED</b></td>
2179
   *                              <td>
2180
   *                              Replace invalid code points for the given document type with a
2181
   *                              Unicode Replacement Character U+FFFD (UTF-8) or &#38;#38;#FFFD;
2182
   *                              (otherwise) instead of leaving them as is. This may be useful, for
2183
   *                              instance, to ensure the well-formedness of XML documents with
2184
   *                              embedded external content.
2185
   *                              </td>
2186
   *                              </tr>
2187
   *                              <tr valign="top">
2188
   *                              <td><b>ENT_HTML401</b></td>
2189
   *                              <td>
2190
   *                              Handle code as HTML 4.01.
2191
   *                              </td>
2192
   *                              </tr>
2193
   *                              <tr valign="top">
2194
   *                              <td><b>ENT_XML1</b></td>
2195
   *                              <td>
2196
   *                              Handle code as XML 1.
2197
   *                              </td>
2198
   *                              </tr>
2199
   *                              <tr valign="top">
2200
   *                              <td><b>ENT_XHTML</b></td>
2201
   *                              <td>
2202
   *                              Handle code as XHTML.
2203
   *                              </td>
2204
   *                              </tr>
2205
   *                              <tr valign="top">
2206
   *                              <td><b>ENT_HTML5</b></td>
2207
   *                              <td>
2208
   *                              Handle code as HTML 5.
2209
   *                              </td>
2210
   *                              </tr>
2211
   *                              </table>
2212
   *                              </p>
2213
   * @param string $encoding      [optional] <p>
2214
   *                              Defines encoding used in conversion.
2215
   *                              </p>
2216
   *                              <p>
2217
   *                              For the purposes of this function, the encodings
2218
   *                              ISO-8859-1, ISO-8859-15,
2219
   *                              UTF-8, cp866,
2220
   *                              cp1251, cp1252, and
2221
   *                              KOI8-R are effectively equivalent, provided the
2222
   *                              <i>string</i> itself is valid for the encoding, as
2223
   *                              the characters affected by <b>htmlspecialchars</b> occupy
2224
   *                              the same positions in all of these encodings.
2225
   *                              </p>
2226
   * @param bool   $double_encode [optional] <p>
2227
   *                              When <i>double_encode</i> is turned off PHP will not
2228
   *                              encode existing html entities, the default is to convert everything.
2229
   *                              </p>
2230
   *
2231
   * @return string The converted string.
2232 1
   * </p>
2233
   * <p>
2234 1
   * If the input <i>string</i> contains an invalid code unit
2235
   * sequence within the given <i>encoding</i> an empty string
2236
   * will be returned, unless either the <b>ENT_IGNORE</b> or
2237
   * <b>ENT_SUBSTITUTE</b> flags are set.
2238 1
   */
2239
  public static function htmlspecialchars($str, $flags = ENT_COMPAT, $encoding = 'UTF-8', $double_encode = true)
2240
  {
2241
    if ($encoding !== 'UTF-8') {
2242
      $encoding = self::normalize_encoding($encoding);
2243
    }
2244
2245
    return htmlspecialchars($str, $flags, $encoding, $double_encode);
2246 1
  }
2247
2248 1
  /**
2249
   * Checks whether iconv is available on the server.
2250
   *
2251
   * @return bool <p><strong>true</strong> if available, <strong>false</strong> otherwise.</p>
2252
   */
2253
  public static function iconv_loaded()
2254
  {
2255
    return extension_loaded('iconv') ? true : false;
2256
  }
2257
2258
  /**
2259
   * Converts Integer to hexadecimal U+xxxx code point representation.
2260
   *
2261 3
   * INFO: opposite to UTF8::hex_to_int()
2262
   *
2263 3
   * @param int    $int  <p>The integer to be converted to hexadecimal code point.</p>
2264 3
   * @param string $pfix [optional]
2265
   *
2266 3
   * @return string <p>The code point, or empty string on failure.</p>
2267
   */
2268 3
  public static function int_to_hex($int, $pfix = 'U+')
2269
  {
2270
    if (ctype_digit((string)$int)) {
2271
      $hex = dechex((int)$int);
2272
2273
      $hex = (strlen($hex) < 4 ? substr('0000' . $hex, -4) : $hex);
2274
2275
      return $pfix . $hex;
2276
    }
2277
2278
    return '';
2279 1
  }
2280
2281 1
  /**
2282
   * Checks whether intl-char is available on the server.
2283
   *
2284
   * @return bool <p><strong>true</strong> if available, <strong>false</strong> otherwise.</p>
2285
   */
2286
  public static function intlChar_loaded()
2287
  {
2288
    return (Bootup::is_php('7.0') === true && class_exists('IntlChar') === true);
2289 2
  }
2290
2291 2
  /**
2292
   * Checks whether intl is available on the server.
2293
   *
2294
   * @return bool <p><strong>true</strong> if available, <strong>false</strong> otherwise.</p>
2295
   */
2296
  public static function intl_loaded()
2297
  {
2298
    return extension_loaded('intl') ? true : false;
2299
  }
2300
2301
  /**
2302
   * alias for "UTF8::is_ascii()"
2303 2
   *
2304
   * @see UTF8::is_ascii()
2305 2
   *
2306
   * @param string $str
2307
   *
2308
   * @return boolean
2309
   */
2310
  public static function isAscii($str)
2311
  {
2312
    return self::is_ascii($str);
2313
  }
2314
2315
  /**
2316
   * alias for "UTF8::is_base64()"
2317 1
   *
2318
   * @see UTF8::is_base64()
2319 1
   *
2320
   * @param string $str
2321
   *
2322
   * @return bool
2323
   */
2324
  public static function isBase64($str)
2325
  {
2326
    return self::is_base64($str);
2327
  }
2328
2329
  /**
2330
   * alias for "UTF8::is_binary()"
2331
   *
2332
   * @see UTF8::is_binary()
2333
   *
2334
   * @param string $str
2335
   *
2336
   * @return bool
2337
   */
2338
  public static function isBinary($str)
2339
  {
2340
    return self::is_binary($str);
2341
  }
2342
2343
  /**
2344
   * alias for "UTF8::is_bom()"
2345
   *
2346
   * @see UTF8::is_bom()
2347
   *
2348
   * @param string $utf8_chr
2349
   *
2350
   * @return boolean
2351
   */
2352
  public static function isBom($utf8_chr)
2353
  {
2354
    return self::is_bom($utf8_chr);
2355
  }
2356
2357
  /**
2358
   * alias for "UTF8::is_html()"
2359 1
   *
2360
   * @see UTF8::is_html()
2361 1
   *
2362
   * @param string $str
2363
   *
2364
   * @return boolean
2365
   */
2366
  public static function isHtml($str)
2367
  {
2368
    return self::is_html($str);
2369
  }
2370
2371
  /**
2372
   * alias for "UTF8::is_json()"
2373
   *
2374
   * @see UTF8::is_json()
2375
   *
2376
   * @param string $str
2377
   *
2378
   * @return bool
2379
   */
2380
  public static function isJson($str)
2381
  {
2382
    return self::is_json($str);
2383
  }
2384
2385
  /**
2386
   * alias for "UTF8::is_utf16()"
2387 1
   *
2388
   * @see UTF8::is_utf16()
2389 1
   *
2390
   * @param string $str
2391
   *
2392
   * @return int|false false if is't not UTF16, 1 for UTF-16LE, 2 for UTF-16BE.
2393
   */
2394
  public static function isUtf16($str)
2395
  {
2396
    return self::is_utf16($str);
2397
  }
2398
2399
  /**
2400
   * alias for "UTF8::is_utf32()"
2401 1
   *
2402
   * @see UTF8::is_utf32()
2403 1
   *
2404
   * @param string $str
2405
   *
2406
   * @return int|false false if is't not UTF16, 1 for UTF-32LE, 2 for UTF-32BE.
2407
   */
2408
  public static function isUtf32($str)
2409
  {
2410
    return self::is_utf32($str);
2411
  }
2412
2413
  /**
2414
   * alias for "UTF8::is_utf8()"
2415
   *
2416 16
   * @see UTF8::is_utf8()
2417
   *
2418 16
   * @param string $str
2419
   * @param bool   $strict
2420
   *
2421
   * @return bool
2422
   */
2423
  public static function isUtf8($str, $strict = false)
2424
  {
2425
    return self::is_utf8($str, $strict);
2426
  }
2427
2428
  /**
2429
   * Checks if a string is 7 bit ASCII.
2430
   *
2431 28
   * @param string $str <p>The string to check.</p>
2432
   *
2433 28
   * @return bool <p>
2434
   *              <strong>true</strong> if it is ASCII<br />
2435 28
   *              <strong>false</strong> otherwise
2436 5
   *              </p>
2437
   */
2438
  public static function is_ascii($str)
2439 28
  {
2440
    $str = (string)$str;
2441
2442
    if (!isset($str[0])) {
2443
      return true;
2444
    }
2445
2446
    return (bool)!preg_match('/[\x80-\xFF]/', $str);
2447
  }
2448
2449 1
  /**
2450
   * Returns true if the string is base64 encoded, false otherwise.
2451 1
   *
2452
   * @param string $str <p>The input string.</p>
2453 1
   *
2454 1
   * @return bool <p>Whether or not $str is base64 encoded.</p>
2455
   */
2456
  public static function is_base64($str)
2457 1
  {
2458 1
    $str = (string)$str;
2459
2460 1
    if (!isset($str[0])) {
2461
      return false;
2462
    }
2463
2464
    if (base64_encode(base64_decode($str, true)) === $str) {
2465
      return true;
2466
    } else {
2467
      return false;
2468
    }
2469
  }
2470
2471 16
  /**
2472
   * Check if the input is binary... (is look like a hack).
2473
   *
2474 16
   * @param mixed $input
2475
   *
2476
   * @return bool
2477 16
   */
2478
  public static function is_binary($input)
2479 16
  {
2480 16
2481 15
    $testLength = strlen($input);
2482 16
2483 6
    if (
2484
        preg_match('~^[01]+$~', $input)
2485 15
        ||
2486
        substr_count($input, "\x00") > 0
2487
        ||
2488
        ($testLength ? substr_count($input, '^ -~') / $testLength > 0.3 : 1 === 0)
2489
    ) {
2490
      return true;
2491
    } else {
2492
      return false;
2493
    }
2494
  }
2495
2496
  /**
2497
   * Check if the file is binary.
2498
   *
2499
   * @param string $file
2500
   *
2501
   * @return boolean
2502
   */
2503
  public static function is_binary_file($file)
2504
  {
2505
    try {
2506
      $fp = fopen($file, 'r');
2507
      $block = fread($fp, 512);
2508
      fclose($fp);
2509
    } catch (\Exception $e) {
2510
      $block = '';
2511
    }
2512
2513
    return self::is_binary($block);
2514
  }
2515
2516
  /**
2517
   * Checks if the given string is equal to any "Byte Order Mark".
2518
   *
2519
   * WARNING: Use "UTF8::string_has_bom()" if you will check BOM in a string.
2520
   *
2521
   * @param string $str <p>The input string.</p>
2522
   *
2523
   * @return bool <p><strong>true</strong> if the $utf8_chr is Byte Order Mark, <strong>false</strong> otherwise.</p>
2524
   */
2525
  public static function is_bom($str)
2526
  {
2527
    foreach (self::$bom as $bomString => $bomByteLength) {
2528
      if ($str === $bomString) {
2529
        return true;
2530
      }
2531
    }
2532
2533
    return false;
2534
  }
2535
2536 1
  /**
2537
   * Check if the string contains any html-tags <lall>.
2538 1
   *
2539
   * @param string $str <p>The input string.</p>
2540 1
   *
2541
   * @return boolean
2542
   */
2543
  public static function is_html($str)
2544
  {
2545 1
    $str = (string)$str;
2546
2547 1
    if (!isset($str[0])) {
2548
      return false;
2549 1
    }
2550 1
2551
    // init
2552 1
    $matches = array();
2553
2554
    preg_match("/<\/?\w+((\s+\w+(\s*=\s*(?:\".*?\"|'.*?'|[^'\">\s]+))?)+\s*|\s*)\/?>/", $str, $matches);
2555
2556
    if (count($matches) == 0) {
2557
      return false;
2558
    } else {
2559
      return true;
2560
    }
2561
  }
2562
2563 1
  /**
2564
   * Try to check if "$str" is an json-string.
2565 1
   *
2566
   * @param string $str <p>The input string.</p>
2567 1
   *
2568
   * @return bool
2569
   */
2570
  public static function is_json($str)
2571
  {
2572 1
    $str = (string)$str;
2573 1
2574 1
    if (!isset($str[0])) {
2575 1
      return false;
2576 1
    }
2577
2578 1
    if (
2579
        is_object(self::json_decode($str))
2580
        &&
2581
        json_last_error() === JSON_ERROR_NONE
2582
    ) {
2583
      return true;
2584
    } else {
2585
      return false;
2586
    }
2587
  }
2588
2589
  /**
2590
   * Check if the string is UTF-16.
2591
   *
2592
   * @param string $str <p>The input string.</p>
2593 4
   *
2594
   * @return int|false <p>
2595 4
   *                   <strong>false</strong> if is't not UTF-16,<br />
2596
   *                   <strong>1</strong> for UTF-16LE,<br />
2597 4
   *                   <strong>2</strong> for UTF-16BE.
2598
   *                   </p>
2599 4
   */
2600 4 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...
2601 4
  {
2602 4
    $str = self::remove_bom($str);
2603 4
2604 4
    if (self::is_binary($str)) {
2605 4
2606 4
      $maybeUTF16LE = 0;
2607 4
      $test = \mb_convert_encoding($str, 'UTF-8', 'UTF-16LE');
2608 2
      if ($test) {
2609 2
        $test2 = \mb_convert_encoding($test, 'UTF-16LE', 'UTF-8');
2610 4
        $test3 = \mb_convert_encoding($test2, 'UTF-8', 'UTF-16LE');
2611 4
        if ($test3 === $test) {
2612 4
          $strChars = self::count_chars($str, true);
2613
          foreach (self::count_chars($test3, true) as $test3char => $test3charEmpty) {
2614 4
            if (in_array($test3char, $strChars, true) === true) {
2615 4
              $maybeUTF16LE++;
2616 4
            }
2617 4
          }
2618 4
        }
2619 4
      }
2620 4
2621 4
      $maybeUTF16BE = 0;
2622 4
      $test = \mb_convert_encoding($str, 'UTF-8', 'UTF-16BE');
2623 3
      if ($test) {
2624 3
        $test2 = \mb_convert_encoding($test, 'UTF-16BE', 'UTF-8');
2625 4
        $test3 = \mb_convert_encoding($test2, 'UTF-8', 'UTF-16BE');
2626 4
        if ($test3 === $test) {
2627 4
          $strChars = self::count_chars($str, true);
2628
          foreach (self::count_chars($test3, true) as $test3char => $test3charEmpty) {
2629 4
            if (in_array($test3char, $strChars, true) === true) {
2630 3
              $maybeUTF16BE++;
2631 2
            }
2632
          }
2633 3
        }
2634
      }
2635
2636
      if ($maybeUTF16BE !== $maybeUTF16LE) {
2637 3
        if ($maybeUTF16LE > $maybeUTF16BE) {
2638
          return 1;
2639 3
        } else {
2640
          return 2;
2641
        }
2642
      }
2643
2644
    }
2645
2646
    return false;
2647
  }
2648
2649
  /**
2650
   * Check if the string is UTF-32.
2651
   *
2652
   * @param string $str
2653 3
   *
2654
   * @return int|false <p>
2655 3
   *                   <strong>false</strong> if is't not UTF-16,<br />
2656
   *                   <strong>1</strong> for UTF-32LE,<br />
2657 3
   *                   <strong>2</strong> for UTF-32BE.
2658
   *                   </p>
2659 3
   */
2660 3 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...
2661 3
  {
2662 3
    $str = self::remove_bom($str);
2663 3
2664 3
    if (self::is_binary($str)) {
2665 3
2666 3
      $maybeUTF32LE = 0;
2667 3
      $test = \mb_convert_encoding($str, 'UTF-8', 'UTF-32LE');
2668 1
      if ($test) {
2669 1
        $test2 = \mb_convert_encoding($test, 'UTF-32LE', 'UTF-8');
2670 3
        $test3 = \mb_convert_encoding($test2, 'UTF-8', 'UTF-32LE');
2671 3
        if ($test3 === $test) {
2672 3
          $strChars = self::count_chars($str, true);
2673
          foreach (self::count_chars($test3, true) as $test3char => $test3charEmpty) {
2674 3
            if (in_array($test3char, $strChars, true) === true) {
2675 3
              $maybeUTF32LE++;
2676 3
            }
2677 3
          }
2678 3
        }
2679 3
      }
2680 3
2681 3
      $maybeUTF32BE = 0;
2682 3
      $test = \mb_convert_encoding($str, 'UTF-8', 'UTF-32BE');
2683 1
      if ($test) {
2684 1
        $test2 = \mb_convert_encoding($test, 'UTF-32BE', 'UTF-8');
2685 3
        $test3 = \mb_convert_encoding($test2, 'UTF-8', 'UTF-32BE');
2686 3
        if ($test3 === $test) {
2687 3
          $strChars = self::count_chars($str, true);
2688
          foreach (self::count_chars($test3, true) as $test3char => $test3charEmpty) {
2689 3
            if (in_array($test3char, $strChars, true) === true) {
2690 1
              $maybeUTF32BE++;
2691 1
            }
2692
          }
2693 1
        }
2694
      }
2695
2696
      if ($maybeUTF32BE !== $maybeUTF32LE) {
2697 3
        if ($maybeUTF32LE > $maybeUTF32BE) {
2698
          return 1;
2699 3
        } else {
2700
          return 2;
2701
        }
2702
      }
2703
2704
    }
2705
2706
    return false;
2707
  }
2708
2709
  /**
2710
   * Checks whether the passed string contains only byte sequences that appear valid UTF-8 characters.
2711
   *
2712 43
   * @see    http://hsivonen.iki.fi/php-utf8/
2713
   *
2714 43
   * @param string $str    <p>The string to be checked.</p>
2715
   * @param bool   $strict <p>Check also if the string is not UTF-16 or UTF-32.</p>
2716 43
   *
2717 3
   * @return bool
2718
   */
2719
  public static function is_utf8($str, $strict = false)
2720 41
  {
2721 1
    $str = (string)$str;
2722 1
2723
    if (!isset($str[0])) {
2724
      return true;
2725
    }
2726
2727
    if ($strict === true) {
2728
      if (self::is_utf16($str) !== false) {
2729
        return false;
2730 41
      }
2731
2732
      if (self::is_utf32($str) !== false) {
2733
        return false;
2734
      }
2735
    }
2736
2737
    if (self::pcre_utf8_support() !== true) {
2738
2739
      // If even just the first character can be matched, when the /u
2740 41
      // modifier is used, then it's valid UTF-8. If the UTF-8 is somehow
2741
      // invalid, nothing at all will match, even if the string contains
2742 41
      // some valid sequences
2743 41
      return (preg_match('/^.{1}/us', $str, $ar) === 1);
2744 41
2745
    } else {
2746
2747 41
      $mState = 0; // cached expected number of octets after the current octet
2748 41
      // until the beginning of the next UTF8 character sequence
2749 41
      $mUcs4 = 0; // cached Unicode character
2750
      $mBytes = 1; // cached expected number of octets in the current sequence
2751
      $len = strlen($str);
2752 41
2753
      /** @noinspection ForeachInvariantsInspection */
2754 36
      for ($i = 0; $i < $len; $i++) {
2755 41
        $in = ord($str[$i]);
2756
        if ($mState === 0) {
2757 34
          // When mState is zero we expect either a US-ASCII character or a
2758 34
          // multi-octet sequence.
2759 34
          if (0 === (0x80 & $in)) {
2760 34
            // US-ASCII, pass straight through.
2761 39
            $mBytes = 1;
2762 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...
2763 21
            // First octet of 2 octet sequence.
2764 21
            $mUcs4 = $in;
2765 21
            $mUcs4 = ($mUcs4 & 0x1F) << 6;
2766 21
            $mState = 1;
2767 33
            $mBytes = 2;
2768
          } elseif (0xE0 === (0xF0 & $in)) {
2769 9
            // First octet of 3 octet sequence.
2770 9
            $mUcs4 = $in;
2771 9
            $mUcs4 = ($mUcs4 & 0x0F) << 12;
2772 9
            $mState = 2;
2773 16
            $mBytes = 3;
2774 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...
2775
            // First octet of 4 octet sequence.
2776
            $mUcs4 = $in;
2777
            $mUcs4 = ($mUcs4 & 0x07) << 18;
2778
            $mState = 3;
2779
            $mBytes = 4;
2780
          } elseif (0xF8 === (0xFC & $in)) {
2781
            /* First octet of 5 octet sequence.
2782 3
            *
2783 3
            * This is illegal because the encoded codepoint must be either
2784 3
            * (a) not the shortest form or
2785 3
            * (b) outside the Unicode range of 0-0x10FFFF.
2786 9
            * Rather than trying to resynchronize, we will carry on until the end
2787
            * of the sequence and let the later error handling code catch it.
2788 3
            */
2789 3
            $mUcs4 = $in;
2790 3
            $mUcs4 = ($mUcs4 & 0x03) << 24;
2791 3
            $mState = 4;
2792 3
            $mBytes = 5;
2793 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...
2794
            // First octet of 6 octet sequence, see comments for 5 octet sequence.
2795
            $mUcs4 = $in;
2796 5
            $mUcs4 = ($mUcs4 & 1) << 30;
2797
            $mState = 5;
2798 41
            $mBytes = 6;
2799
          } else {
2800
            /* Current octet is neither in the US-ASCII range nor a legal first
2801 36
             * octet of a multi-octet sequence.
2802
             */
2803 33
            return false;
2804 33
          }
2805 33
        } else {
2806 33
          // When mState is non-zero, we expect a continuation of the multi-octet
2807
          // sequence
2808
          if (0x80 === (0xC0 & $in)) {
2809
            // Legal continuation.
2810
            $shift = ($mState - 1) * 6;
2811 33
            $tmp = $in;
2812
            $tmp = ($tmp & 0x0000003F) << $shift;
2813
            $mUcs4 |= $tmp;
2814
            /**
2815
             * End of the multi-octet sequence. mUcs4 now contains the final
2816
             * Unicode code point to be output
2817 33
             */
2818 33
            if (0 === --$mState) {
2819 33
              /*
2820 33
              * Check for illegal sequences and code points.
2821
              */
2822 33
              // From Unicode 3.1, non-shortest form is illegal
2823
              if (
2824 33
                  (2 === $mBytes && $mUcs4 < 0x0080) ||
2825 33
                  (3 === $mBytes && $mUcs4 < 0x0800) ||
2826 5
                  (4 === $mBytes && $mUcs4 < 0x10000) ||
2827
                  (4 < $mBytes) ||
2828
                  // From Unicode 3.2, surrogate characters are illegal.
2829 33
                  (($mUcs4 & 0xFFFFF800) === 0xD800) ||
2830 33
                  // Code points outside the Unicode range are illegal.
2831 33
                  ($mUcs4 > 0x10FFFF)
2832 33
              ) {
2833 33
                return false;
2834
              }
2835
              // initialize UTF8 cache
2836
              $mState = 0;
2837
              $mUcs4 = 0;
2838 18
              $mBytes = 1;
2839
            }
2840
          } else {
2841 41
            /**
2842
             *((0xC0 & (*in) != 0x80) && (mState != 0))
2843 20
             * Incomplete multi-octet sequence.
2844
             */
2845
            return false;
2846
          }
2847
        }
2848
      }
2849
2850
      return true;
2851
    }
2852
  }
2853
2854
  /**
2855
   * (PHP 5 &gt;= 5.2.0, PECL json &gt;= 1.2.0)<br/>
2856
   * Decodes a JSON string
2857
   *
2858
   * @link http://php.net/manual/en/function.json-decode.php
2859
   *
2860
   * @param string $json    <p>
2861
   *                        The <i>json</i> string being decoded.
2862
   *                        </p>
2863
   *                        <p>
2864
   *                        This function only works with UTF-8 encoded strings.
2865
   *                        </p>
2866
   *                        <p>PHP implements a superset of
2867
   *                        JSON - it will also encode and decode scalar types and <b>NULL</b>. The JSON standard
2868
   *                        only supports these values when they are nested inside an array or an object.
2869
   *                        </p>
2870
   * @param bool   $assoc   [optional] <p>
2871
   *                        When <b>TRUE</b>, returned objects will be converted into
2872
   *                        associative arrays.
2873
   *                        </p>
2874
   * @param int    $depth   [optional] <p>
2875
   *                        User specified recursion depth.
2876
   *                        </p>
2877
   * @param int    $options [optional] <p>
2878
   *                        Bitmask of JSON decode options. Currently only
2879
   *                        <b>JSON_BIGINT_AS_STRING</b>
2880
   *                        is supported (default is to cast large integers as floats)
2881
   *                        </p>
2882
   *
2883 2
   * @return mixed the value encoded in <i>json</i> in appropriate
2884
   * PHP type. Values true, false and
2885 2
   * null (case-insensitive) are returned as <b>TRUE</b>, <b>FALSE</b>
2886
   * and <b>NULL</b> respectively. <b>NULL</b> is returned if the
2887 2
   * <i>json</i> cannot be decoded or if the encoded
2888 2
   * data is deeper than the recursion limit.
2889 2
   */
2890
  public static function json_decode($json, $assoc = false, $depth = 512, $options = 0)
2891
  {
2892
    $json = self::filter($json);
2893 2
2894
    if (Bootup::is_php('5.4') === true) {
2895
      $json = json_decode($json, $assoc, $depth, $options);
2896
    } else {
2897
      $json = json_decode($json, $assoc, $depth);
2898
    }
2899
2900
    return $json;
2901
  }
2902
2903
  /**
2904
   * (PHP 5 &gt;= 5.2.0, PECL json &gt;= 1.2.0)<br/>
2905
   * Returns the JSON representation of a value.
2906
   *
2907
   * @link http://php.net/manual/en/function.json-encode.php
2908
   *
2909
   * @param mixed $value   <p>
2910
   *                       The <i>value</i> being encoded. Can be any type except
2911
   *                       a resource.
2912
   *                       </p>
2913
   *                       <p>
2914
   *                       All string data must be UTF-8 encoded.
2915
   *                       </p>
2916
   *                       <p>PHP implements a superset of
2917
   *                       JSON - it will also encode and decode scalar types and <b>NULL</b>. The JSON standard
2918
   *                       only supports these values when they are nested inside an array or an object.
2919
   *                       </p>
2920
   * @param int   $options [optional] <p>
2921
   *                       Bitmask consisting of <b>JSON_HEX_QUOT</b>,
2922
   *                       <b>JSON_HEX_TAG</b>,
2923
   *                       <b>JSON_HEX_AMP</b>,
2924
   *                       <b>JSON_HEX_APOS</b>,
2925
   *                       <b>JSON_NUMERIC_CHECK</b>,
2926
   *                       <b>JSON_PRETTY_PRINT</b>,
2927
   *                       <b>JSON_UNESCAPED_SLASHES</b>,
2928
   *                       <b>JSON_FORCE_OBJECT</b>,
2929
   *                       <b>JSON_UNESCAPED_UNICODE</b>. The behaviour of these
2930
   *                       constants is described on
2931
   *                       the JSON constants page.
2932 2
   *                       </p>
2933
   * @param int   $depth   [optional] <p>
2934 2
   *                       Set the maximum depth. Must be greater than zero.
2935
   *                       </p>
2936 2
   *
2937
   * @return string a JSON encoded string on success or <b>FALSE</b> on failure.
2938
   */
2939 2
  public static function json_encode($value, $options = 0, $depth = 512)
2940
  {
2941
    $value = self::filter($value);
2942 2
2943
    if (Bootup::is_php('5.5')) {
2944
      $json = json_encode($value, $options, $depth);
2945
    } else {
2946
      $json = json_encode($value, $options);
2947
    }
2948
2949
    return $json;
2950
  }
2951
2952 6
  /**
2953
   * Makes string's first char lowercase.
2954 6
   *
2955
   * @param string $str <p>The input string</p>
2956
   *
2957
   * @return string <p>The resulting string</p>
2958
   */
2959
  public static function lcfirst($str)
2960
  {
2961
    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...
2962
  }
2963
2964
  /**
2965 24
   * Strip whitespace or other characters from beginning of a UTF-8 string.
2966
   *
2967 24
   * @param string $str   <p>The string to be trimmed</p>
2968
   * @param string $chars <p>Optional characters to be stripped</p>
2969 24
   *
2970 2
   * @return string <p>The string with unwanted characters stripped from the left.</p>
2971
   */
2972 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...
2973
  {
2974 23
    $str = (string)$str;
2975 2
2976
    if (!isset($str[0])) {
2977
      return '';
2978 23
    }
2979
2980 23
    // Info: http://nadeausoftware.com/articles/2007/9/php_tip_how_strip_punctuation_characters_web_page#Unicodecharactercategories
2981
    if ($chars === INF || !$chars) {
2982
      return preg_replace('/^[\pZ\pC]+/u', '', $str);
2983
    }
2984
2985
    $chars = INF === $chars ? '\s' : self::rxClass($chars);
2986
2987
    return preg_replace("/^{$chars}+/u", '', $str);
2988
  }
2989
2990 1
  /**
2991
   * Returns the UTF-8 character with the maximum code point in the given data.
2992 1
   *
2993
   * @param mixed $arg <p>A UTF-8 encoded string or an array of such strings.</p>
2994
   *
2995
   * @return string <p>The character with the highest code point than others.</p>
2996 1
   */
2997 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...
2998
  {
2999
    if (is_array($arg)) {
3000
      $arg = implode($arg);
3001
    }
3002
3003
    return self::chr(max(self::codepoints($arg)));
3004
  }
3005
3006
  /**
3007 1
   * Calculates and returns the maximum number of bytes taken by any
3008
   * UTF-8 encoded character in the given string.
3009 1
   *
3010 1
   * @param string $str <p>The original Unicode string.</p>
3011 1
   *
3012
   * @return int <p>Max byte lengths of the given chars.</p>
3013 1
   */
3014
  public static function max_chr_width($str)
3015
  {
3016
    $bytes = self::chr_size_list($str);
3017
    if (count($bytes) > 0) {
3018
      return (int)max($bytes);
3019
    } else {
3020
      return 0;
3021
    }
3022 2
  }
3023
3024 2
  /**
3025
   * Checks whether mbstring is available on the server.
3026 2
   *
3027 2
   * @return bool <p><strong>true</strong> if available, <strong>false</strong> otherwise.</p>
3028 2
   */
3029
  public static function mbstring_loaded()
3030 2
  {
3031
    $return = extension_loaded('mbstring');
3032
3033
    if ($return === true) {
3034
      \mb_internal_encoding('UTF-8');
3035
    }
3036
3037
    return $return;
3038
  }
3039
3040 1
  /**
3041
   * Returns the UTF-8 character with the minimum code point in the given data.
3042 1
   *
3043
   * @param mixed $arg <strong>A UTF-8 encoded string or an array of such strings.</strong>
3044
   *
3045
   * @return string <p>The character with the lowest code point than others.</p>
3046 1
   */
3047 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...
3048
  {
3049
    if (is_array($arg)) {
3050
      $arg = implode($arg);
3051
    }
3052
3053
    return self::chr(min(self::codepoints($arg)));
3054
  }
3055
3056
  /**
3057
   * alias for "UTF8::normalize_encoding()"
3058 1
   *
3059
   * @see UTF8::normalize_encoding()
3060 1
   *
3061
   * @param string $encoding
3062
   *
3063
   * @return string
3064
   */
3065
  public static function normalizeEncoding($encoding)
3066
  {
3067
    return self::normalize_encoding($encoding);
3068
  }
3069
3070 16
  /**
3071
   * Normalize the encoding-"name" input.
3072 16
   *
3073
   * @param string $encoding <p>e.g.: ISO, UTF8, WINDOWS-1251 etc.</p>
3074 16
   *
3075 2
   * @return string <p>e.g.: ISO-8859-1, UTF-8, WINDOWS-1251 etc.</p>
3076
   */
3077
  public static function normalize_encoding($encoding)
3078 16
  {
3079 1
    static $staticNormalizeEncodingCache = array();
3080
3081
    if (!$encoding) {
3082 16
      return false;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return false; (false) is incompatible with the return type documented by voku\helper\UTF8::normalize_encoding of type string.

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

Let’s take a look at an example:

class Author {
    private $name;

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

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

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

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

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

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

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

Loading history...
3083 4
    }
3084
3085
    if ('UTF-8' === $encoding) {
3086 15
      return $encoding;
3087 14
    }
3088
3089
    if (in_array($encoding, self::$iconvEncoding, true)) {
3090 4
      return $encoding;
3091 4
    }
3092 4
3093
    if (isset($staticNormalizeEncodingCache[$encoding])) {
3094
      return $staticNormalizeEncodingCache[$encoding];
3095 4
    }
3096 4
3097 4
    $encodingOrig = $encoding;
3098 4
    $encoding = strtoupper($encoding);
3099 4
    $encodingUpperHelper = preg_replace('/[^a-zA-Z0-9\s]/', '', $encoding);
3100 4
3101 4
    $equivalences = array(
3102 4
        'ISO88591'    => 'ISO-8859-1',
3103 4
        'ISO8859'     => 'ISO-8859-1',
3104 4
        'ISO'         => 'ISO-8859-1',
3105 4
        'LATIN1'      => 'ISO-8859-1',
3106 4
        'LATIN'       => 'ISO-8859-1',
3107 4
        'WIN1252'     => 'ISO-8859-1',
3108 4
        'WINDOWS1252' => 'ISO-8859-1',
3109 4
        'UTF16'       => 'UTF-16',
3110
        'UTF32'       => 'UTF-32',
3111 4
        'UTF8'        => 'UTF-8',
3112 4
        'UTF'         => 'UTF-8',
3113 4
        'UTF7'        => 'UTF-7',
3114
        '8BIT'        => 'CP850',
3115 4
        'BINARY'      => 'CP850',
3116
    );
3117 4
3118
    if (!empty($equivalences[$encodingUpperHelper])) {
3119
      $encoding = $equivalences[$encodingUpperHelper];
3120
    }
3121
3122
    $staticNormalizeEncodingCache[$encodingOrig] = $encoding;
3123
3124
    return $encoding;
3125
  }
3126
3127 13
  /**
3128
   * Normalize some MS Word special characters.
3129 13
   *
3130 13
   * @param string $str <p>The string to be normalized.</p>
3131
   *
3132 13
   * @return string
3133 1
   */
3134 1 View Code Duplication
  public static function normalize_msword($str)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

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

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

Loading history...
3135 1
  {
3136
    // init
3137 13
    $str = (string)$str;
3138
3139
    if (!isset($str[0])) {
3140
      return '';
3141
    }
3142
3143
    static $utf8MSWordKeys = null;
3144
    static $utf8MSWordValues = null;
3145
3146
    if ($utf8MSWordKeys === null) {
3147
      $utf8MSWordKeys = array_keys(self::$utf8MSWord);
3148
      $utf8MSWordValues = array_values(self::$utf8MSWord);
3149
    }
3150 18
3151
    return str_replace($utf8MSWordKeys, $utf8MSWordValues, $str);
3152 18
  }
3153 18
3154
  /**
3155 18
   * Normalize the whitespace.
3156
   *
3157 18
   * @param string $str                     <p>The string to be normalized.</p>
3158
   * @param bool   $keepNonBreakingSpace    [optional] <p>Set to true, to keep non-breaking-spaces.</p>
3159 2
   * @param bool   $keepBidiUnicodeControls [optional] <p>Set to true, to keep non-printable (for the web)
3160
   *                                        bidirectional text chars.</p>
3161 2
   *
3162
   * @return string
3163 1
   */
3164 1
  public static function normalize_whitespace($str, $keepNonBreakingSpace = false, $keepBidiUnicodeControls = false)
3165
  {
3166 2
    static $whitespaces = array();
3167 2
    static $bidiUniCodeControls = null;
3168
3169 18
    $cacheKey = (int)$keepNonBreakingSpace;
3170 18
3171 1
    if (!isset($whitespaces[$cacheKey])) {
3172 1
3173
      $whitespaces[$cacheKey] = self::$whitespaceTable;
3174 18
3175 18
      if ($keepNonBreakingSpace === true) {
3176
        /** @noinspection OffsetOperationsInspection */
3177 18
        unset($whitespaces[$cacheKey]['NO-BREAK SPACE']);
3178
      }
3179
3180
      $whitespaces[$cacheKey] = array_values($whitespaces[$cacheKey]);
3181
    }
3182
3183
    if ($keepBidiUnicodeControls === false) {
3184
      if ($bidiUniCodeControls === null) {
3185
        $bidiUniCodeControls = array_values(self::$bidiUniCodeControlsTable);
3186
      }
3187
3188
      $str = str_replace($bidiUniCodeControls, '', $str);
3189
    }
3190
3191
    return str_replace($whitespaces[$cacheKey], ' ', $str);
3192
  }
3193
3194
  /**
3195
   * Format a number with grouped thousands.
3196
   *
3197
   * @param float  $number
3198
   * @param int    $decimals
3199
   * @param string $dec_point
3200
   * @param string $thousands_sep
3201
   *
3202
   * @return string
3203
   *    *
3204
   * @deprecated Because this has nothing to do with UTF8. :/
3205
   */
3206
  public static function number_format($number, $decimals = 0, $dec_point = '.', $thousands_sep = ',')
3207
  {
3208
    $thousands_sep = (string)$thousands_sep;
3209
    $dec_point = (string)$dec_point;
3210
3211
    if (
3212
        isset($thousands_sep[1], $dec_point[1])
3213
        &&
3214
        Bootup::is_php('5.4') === true
3215
    ) {
3216
      return str_replace(
3217
          array(
3218
              '.',
3219
              ',',
3220
          ),
3221
          array(
3222
              $dec_point,
3223
              $thousands_sep,
3224
          ),
3225
          number_format($number, $decimals, '.', ',')
3226
      );
3227
    }
3228
3229
    return number_format($number, $decimals, $dec_point, $thousands_sep);
3230 17
  }
3231
3232 17
  /**
3233 3
   * Calculates Unicode code point of the given UTF-8 encoded character.
3234
   *
3235
   * INFO: opposite to UTF8::chr()
3236 16
   *
3237
   * @param string      $chr      <p>The character of which to calculate code point.<p/>
3238
   * @param string|null $encoding [optional] <p>Default is UTF-8</p>
3239
   *
3240 16
   * @return int <p>
3241
   *             Unicode code point of the given character,<br />
3242
   *             0 on invalid UTF-8 byte sequence.
3243
   *             </p>
3244
   */
3245
  public static function ord($chr, $encoding = 'UTF-8')
3246
  {
3247
    if (!$chr && $chr !== '0') {
3248 16
      return 0;
3249 16
    }
3250 15
3251
    if ($encoding !== 'UTF-8') {
3252
      $encoding = self::normalize_encoding($encoding);
3253 9
      $chr = (string)\mb_convert_encoding($chr, 'UTF-8', $encoding);
3254 9
    }
3255 9
3256
    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
3257 9
      self::checkForSupport();
3258 1
    }
3259
3260
    if (self::$support['intlChar'] === true) {
3261 9
      $tmpReturn = \IntlChar::ord($chr);
3262 4
      if ($tmpReturn) {
3263
        return $tmpReturn;
3264
      }
3265 9
    }
3266 5
3267
    // use static cache, if there is no support for "IntlChar"
3268
    static $cache = array();
3269 9
    if (isset($cache[$chr]) === true) {
3270
      return $cache[$chr];
3271
    }
3272
3273
    $chr_orig = $chr;
3274
    /** @noinspection CallableParameterUseCaseInTypeContextInspection */
3275
    $chr = unpack('C*', substr($chr, 0, 4));
3276
    $code = $chr ? $chr[1] : 0;
3277
3278
    if (0xF0 <= $code && isset($chr[4])) {
3279
      return $cache[$chr_orig] = (($code - 0xF0) << 18) + (($chr[2] - 0x80) << 12) + (($chr[3] - 0x80) << 6) + $chr[4] - 0x80;
3280
    }
3281
3282
    if (0xE0 <= $code && isset($chr[3])) {
3283
      return $cache[$chr_orig] = (($code - 0xE0) << 12) + (($chr[2] - 0x80) << 6) + $chr[3] - 0x80;
3284
    }
3285 1
3286
    if (0xC0 <= $code && isset($chr[2])) {
3287
      return $cache[$chr_orig] = (($code - 0xC0) << 6) + $chr[2] - 0x80;
3288 1
    }
3289
3290 1
    return $cache[$chr_orig] = $code;
3291 1
  }
3292 1
3293
  /**
3294
   * Parses the string into an array (into the the second parameter).
3295 1
   *
3296
   * WARNING: Instead of "parse_str()" this method do not (re-)placing variables in the current scope,
3297
   *          if the second parameter is not set!
3298
   *
3299
   * @link http://php.net/manual/en/function.parse-str.php
3300
   *
3301
   * @param string $str    <p>The input string.</p>
3302
   * @param array  $result <p>The result will be returned into this reference parameter.</p>
3303 41
   *
3304
   * @return bool <p>Will return <strong>false</strong> if php can't parse the string and we haven't any $result.</p>
3305
   */
3306 41
  public static function parse_str($str, &$result)
3307
  {
3308
    // clean broken utf8
3309
    $str = self::clean($str);
3310
3311
    $return = \mb_parse_str($str, $result);
3312
    if ($return === false || empty($result)) {
3313
      return false;
3314
    }
3315
3316
    return true;
3317 1
  }
3318
3319 1
  /**
3320 1
   * Checks if \u modifier is available that enables Unicode support in PCRE.
3321
   *
3322
   * @return bool <p><strong>true</strong> if support is available, <strong>false</strong> otherwise.</p>
3323 1
   */
3324 1
  public static function pcre_utf8_support()
3325 1
  {
3326
    /** @noinspection PhpUsageOfSilenceOperatorInspection */
3327
    return (bool)@preg_match('//u', '');
3328 1
  }
3329
3330
  /**
3331 1
   * Create an array containing a range of UTF-8 characters.
3332
   *
3333
   * @param mixed $var1 <p>Numeric or hexadecimal code points, or a UTF-8 character to start from.</p>
3334
   * @param mixed $var2 <p>Numeric or hexadecimal code points, or a UTF-8 character to end at.</p>
3335 1
   *
3336 1
   * @return array
3337 1
   */
3338
  public static function range($var1, $var2)
3339
  {
3340 1
    if (!$var1 || !$var2) {
3341
      return array();
3342
    }
3343 1
3344 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...
3345
      $start = (int)$var1;
3346
    } elseif (ctype_xdigit($var1)) {
3347 1
      $start = (int)self::hex_to_int($var1);
3348
    } else {
3349 1
      $start = self::ord($var1);
3350 1
    }
3351 1
3352 1
    if (!$start) {
3353 1
      return array();
3354
    }
3355
3356 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...
3357
      $end = (int)$var2;
3358
    } elseif (ctype_xdigit($var2)) {
3359
      $end = (int)self::hex_to_int($var2);
3360
    } else {
3361
      $end = self::ord($var2);
3362
    }
3363
3364
    if (!$end) {
3365 5
      return array();
3366
    }
3367 5
3368
    return array_map(
3369
        array(
3370
            '\\voku\\helper\\UTF8',
3371
            'chr',
3372
        ),
3373
        range($start, $end)
3374
    );
3375
  }
3376
3377 10
  /**
3378
   * alias for "UTF8::remove_bom()"
3379 10
   *
3380 10
   * @see UTF8::remove_bom()
3381 5
   *
3382 5
   * @param string $str
3383 10
   *
3384
   * @return string
3385 10
   */
3386
  public static function removeBOM($str)
3387
  {
3388
    return self::remove_bom($str);
3389
  }
3390
3391
  /**
3392
   * Remove the BOM from UTF-8 / UTF-16 / UTF-32 strings.
3393
   *
3394
   * @param string $str <p>The input string.</p>
3395
   *
3396 1
   * @return string <p>String without UTF-BOM</p>
3397
   */
3398 1
  public static function remove_bom($str)
3399 1
  {
3400 1
    foreach (self::$bom as $bomString => $bomByteLength) {
3401
      if (0 === strpos($str, $bomString)) {
3402 1
        $str = substr($str, $bomByteLength);
3403 1
      }
3404 1
    }
3405 1
3406 1
    return $str;
3407
  }
3408 1
3409
  /**
3410
   * Removes duplicate occurrences of a string in another string.
3411
   *
3412
   * @param string          $str  <p>The base string.</p>
3413
   * @param string|string[] $what <p>String to search for in the base string.</p>
3414
   *
3415
   * @return string <p>The result string with removed duplicates.</p>
3416
   */
3417
  public static function remove_duplicates($str, $what = ' ')
3418
  {
3419
    if (is_string($what)) {
3420
      $what = array($what);
3421
    }
3422
3423
    if (is_array($what)) {
3424 45
      /** @noinspection ForeachSourceInspection */
3425
      foreach ($what as $item) {
3426
        $str = preg_replace('/(' . preg_quote($item, '/') . ')+/', $item, $str);
3427 45
      }
3428
    }
3429
3430
    return $str;
3431 45
  }
3432 45
3433 45
  /**
3434 45
   * Remove invisible characters from a string.
3435
   *
3436 45
   * e.g.: This prevents sandwiching null characters between ascii characters, like Java\0script.
3437
   *
3438
   * copy&past from https://github.com/bcit-ci/CodeIgniter/blob/develop/system/core/Common.php
3439 45
   *
3440 45
   * @param string $str
3441
   * @param bool   $url_encoded
3442 45
   * @param string $replacement
3443
   *
3444
   * @return string
3445
   */
3446
  public static function remove_invisible_characters($str, $url_encoded = true, $replacement = '')
3447
  {
3448
    // init
3449
    $non_displayables = array();
3450
3451
    // every control character except newline (dec 10),
3452
    // 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...
3453 45
    if ($url_encoded) {
3454
      $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...
3455 45
      $non_displayables[] = '/%1[0-9a-f]/'; // url encoded 16-31
3456
    }
3457 45
3458 45
    $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...
3459 45
3460
    do {
3461 45
      $str = preg_replace($non_displayables, $replacement, $str, -1, $count);
3462 45
    } while ($count !== 0);
3463 45
3464
    return $str;
3465 45
  }
3466
3467
  /**
3468
   * Replace the diamond question mark (�) with the replacement.
3469
   *
3470
   * @param string $str
3471
   * @param string $unknown
3472
   *
3473
   * @return string
3474
   */
3475
  public static function replace_diamond_question_mark($str, $unknown = '?')
3476 23
  {
3477
    return str_replace(
3478 23
        array(
3479
            "\xEF\xBF\xBD",
3480 23
            '�',
3481 5
        ),
3482
        array(
3483
            $unknown,
3484
            $unknown,
3485 19
        ),
3486 3
        $str
3487
    );
3488
  }
3489 18
3490
  /**
3491 18
   * Strip whitespace or other characters from end of a UTF-8 string.
3492
   *
3493
   * @param string $str   <p>The string to be trimmed.</p>
3494
   * @param string $chars <p>Optional characters to be stripped.</p>
3495
   *
3496
   * @return string <p>The string with unwanted characters stripped from the right.</p>
3497
   */
3498 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...
3499
  {
3500
    $str = (string)$str;
3501
3502 52
    if (!isset($str[0])) {
3503
      return '';
3504 52
    }
3505
3506 52
    // Info: http://nadeausoftware.com/articles/2007/9/php_tip_how_strip_punctuation_characters_web_page#Unicodecharactercategories
3507
    if ($chars === INF || !$chars) {
3508 52
      return preg_replace('/[\pZ\pC]+$/u', '', $str);
3509 40
    }
3510
3511
    $chars = INF === $chars ? '\s' : self::rxClass($chars);
3512 18
3513
    return preg_replace("/{$chars}+$/u", '', $str);
3514
  }
3515 18
3516 17
  /**
3517
   * rxClass
3518 17
   *
3519 17
   * @param string $s
3520 17
   * @param string $class
3521 2
   *
3522 2
   * @return string
3523
   */
3524
  private static function rxClass($s, $class = '')
3525 18
  {
3526
    static $rxClassCache = array();
3527 18
3528 18
    $cacheKey = $s . $class;
3529 18
3530
    if (isset($rxClassCache[$cacheKey])) {
3531 18
      return $rxClassCache[$cacheKey];
3532 18
    }
3533 18
3534
    /** @noinspection CallableParameterUseCaseInTypeContextInspection */
3535
    $class = array($class);
3536
3537 18
    /** @noinspection SuspiciousLoopInspection */
3538
    foreach (self::str_split($s) as $s) {
3539 18
      if ('-' === $s) {
3540
        $class[0] = '-' . $class[0];
3541
      } elseif (!isset($s[2])) {
3542
        $class[0] .= preg_quote($s, '/');
3543
      } elseif (1 === self::strlen($s)) {
3544
        $class[0] .= $s;
3545
      } else {
3546
        $class[] = $s;
3547
      }
3548
    }
3549
3550
    if ($class[0]) {
3551
      $class[0] = '[' . $class[0] . ']';
3552
    }
3553
3554
    if (1 === count($class)) {
3555
      $return = $class[0];
3556
    } else {
3557
      $return = '(?:' . implode('|', $class) . ')';
3558
    }
3559
3560 1
    $rxClassCache[$cacheKey] = $return;
3561
3562 1
    return $return;
3563 1
  }
3564
3565
  /**
3566
   * WARNING: Echo native UTF8-Support libs, e.g. for debugging.
3567
   */
3568 1
  public static function showSupport()
3569 1
  {
3570 1
    foreach (self::$support as $utf8Support) {
3571 1
      echo $utf8Support . "\n<br>";
3572
    }
3573
  }
3574 1
3575
  /**
3576
   * Converts a UTF-8 character to HTML Numbered Entity like "&#123;".
3577
   *
3578
   * @param string $char           <p>The Unicode character to be encoded as numbered entity.</p>
3579
   * @param bool   $keepAsciiChars <p>Set to <strong>true</strong> to keep ASCII chars.</>
3580
   *
3581
   * @return string <p>The HTML numbered entity.</p>
3582
   */
3583
  public static function single_chr_html_encode($char, $keepAsciiChars = false)
3584
  {
3585
    if (!$char) {
3586 36
      return '';
3587
    }
3588 36
3589
    if (
3590 36
        $keepAsciiChars === true
3591 2
        &&
3592
        self::isAscii($char) === true
3593
    ) {
3594
      return $char;
3595 36
    }
3596 36
3597
    return '&#' . self::ord($char) . ';';
3598 36
  }
3599
3600
  /**
3601
   * Convert a string to an array of Unicode characters.
3602 36
   *
3603
   * @param string  $str       <p>The string to split into array.</p>
3604 36
   * @param int     $length    [optional] <p>Max character length of each array element.</p>
3605 6
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
3606 6
   *
3607
   * @return string[] <p>An array containing chunks of the string.</p>
3608 36
   */
3609 36
  public static function split($str, $length = 1, $cleanUtf8 = false)
3610 36
  {
3611 36
    $str = (string)$str;
3612 36
3613
    if (!isset($str[0])) {
3614 36
      return array();
3615
    }
3616
3617
    // init
3618
    $str = (string)$str;
3619
    $ret = array();
3620
3621
    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
3622
      self::checkForSupport();
3623
    }
3624
3625
    if (self::$support['pcre_utf8'] === true) {
3626
3627
      if ($cleanUtf8 === true) {
3628
        $str = self::clean($str);
3629
      }
3630
3631
      preg_match_all('/./us', $str, $retArray);
3632
      if (isset($retArray[0])) {
3633
        $ret = $retArray[0];
3634
      }
3635
      unset($retArray);
3636
3637
    } else {
3638
3639
      // fallback
3640
3641
      $len = strlen($str);
3642
3643
      /** @noinspection ForeachInvariantsInspection */
3644
      for ($i = 0; $i < $len; $i++) {
3645
        if (($str[$i] & "\x80") === "\x00") {
3646 36
          $ret[] = $str[$i];
3647 5
        } elseif ((($str[$i] & "\xE0") === "\xC0") && isset($str[$i + 1])) {
3648
          if (($str[$i + 1] & "\xC0") === "\x80") {
3649 5
            $ret[] = $str[$i] . $str[$i + 1];
3650 5
3651
            $i++;
3652
          }
3653 36 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...
3654
          if ((($str[$i + 1] & "\xC0") === "\x80") && (($str[$i + 2] & "\xC0") === "\x80")) {
3655
            $ret[] = $str[$i] . $str[$i + 1] . $str[$i + 2];
3656
3657 36
            $i += 2;
3658
          }
3659
        } elseif ((($str[$i] & "\xF8") === "\xF0") && isset($str[$i + 3])) {
3660 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...
3661
            $ret[] = $str[$i] . $str[$i + 1] . $str[$i + 2] . $str[$i + 3];
3662
3663
            $i += 3;
3664
          }
3665
        }
3666
      }
3667
    }
3668
3669
    if ($length > 1) {
3670 12
      $ret = array_chunk($ret, $length);
3671
3672
      $ret = array_map('implode', $ret);
3673
    }
3674
3675
    /** @noinspection OffsetOperationsInspection */
3676 12
    if (isset($ret[0]) && $ret[0] === '') {
3677 2
      return array();
3678 1
    }
3679 2
3680 1
    return $ret;
3681 2
  }
3682
3683 2
  /**
3684
   * Optimized "\mb_detect_encoding()"-function -> with support for UTF-16 and UTF-32.
3685
   *
3686 2
   * @param string $str <p>The input string.</p>
3687
   *
3688
   * @return false|string <p>
3689
   *                      The detected string-encoding e.g. UTF-8 or UTF-16BE,<br />
3690
   *                      otherwise it will return false.
3691
   *                      </p>
3692 12
   */
3693 3
  public static function str_detect_encoding($str)
3694
  {
3695
    //
3696
    // 1.) check binary strings (010001001...) like UTF-16 / UTF-32
3697
    //
3698
3699
    if (self::is_binary($str)) {
3700 12
      if (self::is_utf16($str) === 1) {
3701 9
        return 'UTF-16LE';
3702
      } elseif (self::is_utf16($str) === 2) {
3703
        return 'UTF-16BE';
3704
      } elseif (self::is_utf32($str) === 1) {
3705
        return 'UTF-32LE';
3706
      } elseif (self::is_utf32($str) === 2) {
3707
        return 'UTF-32BE';
3708
      }
3709
    }
3710 6
3711 6
    //
3712 6
    // 2.) simple check for ASCII chars
3713 6
    //
3714 6
3715 6
    if (self::is_ascii($str) === true) {
3716 6
      return 'ASCII';
3717 6
    }
3718 6
3719 6
    //
3720 6
    // 3.) simple check for UTF-8 chars
3721 6
    //
3722 6
3723 6
    if (self::is_utf8($str) === true) {
3724 6
      return 'UTF-8';
3725 6
    }
3726 6
3727 6
    //
3728 6
    // 4.) check via "\mb_detect_encoding()"
3729 6
    //
3730 6
    // INFO: UTF-16, UTF-32, UCS2 and UCS4, encoding detection will fail always with "\mb_detect_encoding()"
3731
3732 6
    $detectOrder = array(
3733 6
        'ISO-8859-1',
3734 6
        'ISO-8859-2',
3735
        'ISO-8859-3',
3736
        'ISO-8859-4',
3737
        'ISO-8859-5',
3738
        'ISO-8859-6',
3739
        'ISO-8859-7',
3740
        'ISO-8859-8',
3741
        'ISO-8859-9',
3742
        'ISO-8859-10',
3743
        'ISO-8859-13',
3744
        'ISO-8859-14',
3745
        'ISO-8859-15',
3746
        'ISO-8859-16',
3747
        'WINDOWS-1251',
3748
        'WINDOWS-1252',
3749
        'WINDOWS-1254',
3750
        'ISO-2022-JP',
3751
        'JIS',
3752
        'EUC-JP',
3753
    );
3754
3755
    $encoding = \mb_detect_encoding($str, $detectOrder, true);
3756
    if ($encoding) {
3757
      return $encoding;
3758
    }
3759
3760
    //
3761
    // 5.) check via "iconv()"
3762
    //
3763
3764
    $md5 = md5($str);
3765
    foreach (self::$iconvEncoding as $encodingTmp) {
3766
      # INFO: //IGNORE and //TRANSLIT still throw notice
3767
      /** @noinspection PhpUsageOfSilenceOperatorInspection */
3768
      if (md5(@iconv($encodingTmp, $encodingTmp, $str)) === $md5) {
3769
        return $encodingTmp;
3770
      }
3771
    }
3772
3773
    return false;
3774
  }
3775
3776
  /**
3777
   * Case-insensitive and UTF-8 safe version of <function>str_replace</function>.
3778 14
   *
3779
   * @link  http://php.net/manual/en/function.str-ireplace.php
3780 14
   *
3781
   * @param mixed $search  <p>
3782
   *                       Every replacement with search array is
3783 14
   *                       performed on the result of previous replacement.
3784 14
   *                       </p>
3785 1
   * @param mixed $replace <p>
3786 1
   *                       </p>
3787 13
   * @param mixed $subject <p>
3788
   *                       If subject is an array, then the search and
3789 14
   *                       replace is performed with every entry of
3790
   *                       subject, and the return value is an array as
3791 14
   *                       well.
3792 14
   *                       </p>
3793
   * @param int   $count   [optional] <p>
3794 14
   *                       The number of matched and replaced needles will
3795
   *                       be returned in count which is passed by
3796
   *                       reference.
3797
   *                       </p>
3798
   *
3799
   * @return mixed <p>A string or an array of replacements.</p>
3800
   */
3801
  public static function str_ireplace($search, $replace, $subject, &$count = null)
3802
  {
3803
    $search = (array)$search;
3804
3805
    /** @noinspection AlterInForeachInspection */
3806 1
    foreach ($search as &$s) {
3807
      if ('' === $s .= '') {
3808 1
        $s = '/^(?<=.)$/';
3809
      } else {
3810 1
        $s = '/' . preg_quote($s, '/') . '/ui';
3811
      }
3812
    }
3813
3814 1
    $subject = preg_replace($search, $replace, $subject, -1, $replace);
3815
    $count = $replace; // used as reference parameter
3816 1
3817
    return $subject;
3818
  }
3819
3820 1
  /**
3821 1
   * Limit the number of characters in a string, but also after the next word.
3822
   *
3823
   * @param string $str
3824 1
   * @param int    $length
3825 1
   * @param string $strAddOn
3826 1
   *
3827 1
   * @return string
3828
   */
3829 1
  public static function str_limit_after_word($str, $length = 100, $strAddOn = '...')
3830
  {
3831
    $str = (string)$str;
3832 1
3833
    if (!isset($str[0])) {
3834
      return '';
3835 1
    }
3836
3837
    $length = (int)$length;
3838
3839
    if (self::strlen($str) <= $length) {
3840
      return $str;
3841
    }
3842
3843
    if (self::substr($str, $length - 1, 1) === ' ') {
3844
      return self::substr($str, 0, $length - 1) . $strAddOn;
3845
    }
3846
3847
    $str = self::substr($str, 0, $length);
3848
    $array = explode(' ', $str);
3849
    array_pop($array);
3850
    $new_str = implode(' ', $array);
3851 2
3852
    if ($new_str === '') {
3853 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...
3854
    } else {
3855
      $str = $new_str . $strAddOn;
3856 2
    }
3857 2
3858
    return $str;
3859 2
  }
3860
3861 2
  /**
3862 2
   * Pad a UTF-8 string to given length with another string.
3863
   *
3864 2
   * @param string $str        <p>The input string.</p>
3865
   * @param int    $pad_length <p>The length of return string.</p>
3866
   * @param string $pad_string [optional] <p>String to use for padding the input string.</p>
3867 2
   * @param int    $pad_type   [optional] <p>
3868 2
   *                           Can be <strong>STR_PAD_RIGHT</strong> (default),
3869 2
   *                           <strong>STR_PAD_LEFT</strong> or <strong>STR_PAD_BOTH</strong>
3870 2
   *                           </p>
3871 2
   *
3872
   * @return string <strong>Returns the padded string</strong>
3873 2
   */
3874 2
  public static function str_pad($str, $pad_length, $pad_string = ' ', $pad_type = STR_PAD_RIGHT)
3875 2
  {
3876 2
    $str_length = self::strlen($str);
3877 2
3878 2
    if (
3879
        is_int($pad_length) === true
3880 2
        &&
3881 2
        $pad_length > 0
3882 2
        &&
3883 2
        $pad_length >= $str_length
3884 2
    ) {
3885 2
      $ps_length = self::strlen($pad_string);
3886
3887 2
      $diff = $pad_length - $str_length;
3888
3889
      switch ($pad_type) {
3890 2 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...
3891
          $pre = str_repeat($pad_string, (int)ceil($diff / $ps_length));
3892
          $pre = self::substr($pre, 0, $diff);
3893
          $post = '';
3894
          break;
3895
3896
        case STR_PAD_BOTH:
3897
          $pre = str_repeat($pad_string, (int)ceil($diff / $ps_length / 2));
3898
          $pre = self::substr($pre, 0, (int)$diff / 2);
3899
          $post = str_repeat($pad_string, (int)ceil($diff / $ps_length / 2));
3900
          $post = self::substr($post, 0, (int)ceil($diff / 2));
3901
          break;
3902
3903
        case STR_PAD_RIGHT:
3904 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...
3905
          $post = str_repeat($pad_string, (int)ceil($diff / $ps_length));
3906
          $post = self::substr($post, 0, $diff);
3907
          $pre = '';
3908
      }
3909
3910
      return $pre . $str . $post;
3911 1
    }
3912
3913 1
    return $str;
3914
  }
3915 1
3916
  /**
3917
   * Repeat a string.
3918
   *
3919
   * @param string $str        <p>
3920
   *                           The string to be repeated.
3921
   *                           </p>
3922
   * @param int    $multiplier <p>
3923
   *                           Number of time the input string should be
3924
   *                           repeated.
3925
   *                           </p>
3926
   *                           <p>
3927
   *                           multiplier has to be greater than or equal to 0.
3928
   *                           If the multiplier is set to 0, the function
3929
   *                           will return an empty string.
3930
   *                           </p>
3931
   *
3932
   * @return string <p>The repeated string.</p>
3933
   */
3934
  public static function str_repeat($str, $multiplier)
3935
  {
3936
    $str = self::filter($str);
3937
3938
    return str_repeat($str, $multiplier);
3939
  }
3940
3941
  /**
3942
   * INFO: This is only a wrapper for "str_replace()"  -> the original functions is already UTF-8 safe.
3943
   *
3944
   * Replace all occurrences of the search string with the replacement string
3945
   *
3946
   * @link http://php.net/manual/en/function.str-replace.php
3947 12
   *
3948
   * @param mixed $search  <p>
3949 12
   *                       The value being searched for, otherwise known as the needle.
3950
   *                       An array may be used to designate multiple needles.
3951
   *                       </p>
3952
   * @param mixed $replace <p>
3953
   *                       The replacement value that replaces found search
3954
   *                       values. An array may be used to designate multiple replacements.
3955
   *                       </p>
3956
   * @param mixed $subject <p>
3957
   *                       The string or array being searched and replaced on,
3958
   *                       otherwise known as the haystack.
3959 1
   *                       </p>
3960
   *                       <p>
3961 1
   *                       If subject is an array, then the search and
3962
   *                       replace is performed with every entry of
3963 1
   *                       subject, and the return value is an array as
3964
   *                       well.
3965 1
   *                       </p>
3966
   * @param int   $count   [optional] If passed, this will hold the number of matched and replaced needles.
3967
   *
3968
   * @return mixed <p>This function returns a string or an array with the replaced values.</p>
3969
   */
3970
  public static function str_replace($search, $replace, $subject, &$count = null)
3971
  {
3972
    return str_replace($search, $replace, $subject, $count);
3973
  }
3974
3975
  /**
3976
   * Shuffles all the characters in the string.
3977 1
   *
3978
   * @param string $str <p>The input string</p>
3979 1
   *
3980
   * @return string <p>The shuffled string.</p>
3981 1
   */
3982 1
  public static function str_shuffle($str)
3983 1
  {
3984
    $array = self::split($str);
3985 1
3986 1
    shuffle($array);
3987 1
3988 1
    return implode('', $array);
3989
  }
3990
3991 1
  /**
3992
   * Sort all characters according to code points.
3993
   *
3994
   * @param string $str    <p>A UTF-8 string.</p>
3995
   * @param bool   $unique <p>Sort unique. If <strong>true</strong>, repeated characters are ignored.</p>
3996
   * @param bool   $desc   <p>If <strong>true</strong>, will sort characters in reverse code point order.</p>
3997
   *
3998
   * @return string <p>String of sorted characters.</p>
3999
   */
4000
  public static function str_sort($str, $unique = false, $desc = false)
4001
  {
4002 21
    $array = self::codepoints($str);
4003
4004
    if ($unique) {
4005 21
      $array = array_flip(array_flip($array));
4006 21
    }
4007
4008 21
    if ($desc) {
4009 1
      arsort($array);
4010
    } else {
4011
      asort($array);
4012 20
    }
4013
4014
    return self::string($array);
4015
  }
4016 20
4017 20
  /**
4018
   * Split a string into an array.
4019 20
   *
4020 20
   * @param string $str
4021
   * @param int    $len
4022
   *
4023 1
   * @return array
4024 1
   */
4025
  public static function str_split($str, $len = 1)
4026
  {
4027 1
    // init
4028 1
    $len = (int)$len;
4029 1
    $str = (string)$str;
4030 1
4031 1
    if (!isset($str[0])) {
4032
      return array();
4033 1
    }
4034
4035 1
    if ($len < 1) {
4036
      return str_split($str, $len);
4037
    }
4038
4039
    /** @noinspection PhpInternalEntityUsedInspection */
4040
    preg_match_all('/' . Grapheme::GRAPHEME_CLUSTER_RX . '/u', $str, $a);
4041
    $a = $a[0];
4042
4043
    if ($len === 1) {
4044
      return $a;
4045 1
    }
4046
4047 1
    $arrayOutput = array();
4048
    $p = -1;
4049 1
4050
    /** @noinspection PhpForeachArrayIsUsedAsValueInspection */
4051 1
    foreach ($a as $l => $a) {
4052
      if ($l % $len) {
4053
        $arrayOutput[$p] .= $a;
4054
      } else {
4055
        $arrayOutput[++$p] = $a;
4056
      }
4057
    }
4058
4059
    return $arrayOutput;
4060
  }
4061
4062
  /**
4063
   * Get a binary representation of a specific string.
4064
   *
4065 7
   * @param string $str <p>The input string.</p>
4066
   *
4067 7
   * @return string
4068
   */
4069
  public static function str_to_binary($str)
4070
  {
4071
    $str = (string)$str;
4072
4073
    $value = unpack('H*', $str);
4074
4075
    return base_convert($value[1], 16, 2);
4076
  }
4077
4078
  /**
4079
   * alias for "UTF8::to_ascii()"
4080
   *
4081
   * @see UTF8::to_ascii()
4082
   *
4083 1
   * @param string $str
4084
   * @param string $unknown
4085 1
   * @param bool   $strict
4086 1
   *
4087
   * @return string
4088 1
   */
4089
  public static function str_transliterate($str, $unknown = '?', $strict = false)
4090 1
  {
4091
    return self::to_ascii($str, $unknown, $strict);
4092 1
  }
4093 1
4094 1
  /**
4095 1
   * Counts number of words in the UTF-8 string.
4096
   *
4097 1
   * @param string $str      <p>The input string.</p>
4098
   * @param int    $format   [optional] <p>
4099 1
   *                         <strong>0</strong> => return a number of words (default)<br />
4100 1
   *                         <strong>1</strong> => return an array of words<br />
4101 1
   *                         <strong>2</strong> => return an array of words with word-offset as key
4102 1
   *                         </p>
4103 1
   * @param string $charlist [optional] <p>Additional chars that contains to words and do not start a new word.</p>
4104 1
   *
4105
   * @return array|int <p>The number of words in the string</p>
4106 1
   */
4107
  public static function str_word_count($str, $format = 0, $charlist = '')
4108 1
  {
4109
    $charlist = self::rxClass($charlist, '\pL');
4110
    $strParts = \preg_split("/({$charlist}+(?:[\p{Pd}’']{$charlist}+)*)/u", $str, -1, PREG_SPLIT_DELIM_CAPTURE);
4111
4112 1
    $len = count($strParts);
4113
4114
    if ($format === 1) {
4115
4116
      $numberOfWords = array();
4117
      for ($i = 1; $i < $len; $i += 2) {
4118
        $numberOfWords[] = $strParts[$i];
4119
      }
4120
4121
    } elseif ($format === 2) {
4122
4123
      $numberOfWords = array();
4124
      $offset = self::strlen($strParts[0]);
4125
      for ($i = 1; $i < $len; $i += 2) {
4126
        $numberOfWords[$offset] = $strParts[$i];
4127
        $offset += self::strlen($strParts[$i]) + self::strlen($strParts[$i + 1]);
4128
      }
4129 9
4130
    } else {
4131 9
4132
      $numberOfWords = ($len - 1) / 2;
4133
4134
    }
4135
4136
    return $numberOfWords;
4137
  }
4138
4139
  /**
4140
   * Case-insensitive string comparison.
4141
   *
4142
   * INFO: Case-insensitive version of UTF8::strcmp()
4143
   *
4144
   * @param string $str1
4145
   * @param string $str2
4146
   *
4147 1
   * @return int <p>
4148
   *             <strong>&lt; 0</strong> if str1 is less than str2;<br />
4149 1
   *             <strong>&gt; 0</strong> if str1 is greater than str2,<br />
4150
   *             <strong>0</strong> if they are equal.
4151
   *             </p>
4152
   */
4153
  public static function strcasecmp($str1, $str2)
4154
  {
4155
    return self::strcmp(self::strtocasefold($str1), self::strtocasefold($str2));
4156
  }
4157
4158
  /**
4159
   * alias for "UTF8::strstr()"
4160
   *
4161
   * @see UTF8::strstr()
4162
   *
4163
   * @param string  $haystack
4164 12
   * @param string  $needle
4165
   * @param bool    $before_needle
4166 12
   * @param string  $encoding
4167 11
   * @param boolean $cleanUtf8
4168 11
   *
4169 12
   * @return string|false
4170
   */
4171
  public static function strchr($haystack, $needle, $before_needle = false, $encoding = 'UTF-8', $cleanUtf8 = false)
4172
  {
4173
    return self::strstr($haystack, $needle, $before_needle, $encoding, $cleanUtf8);
4174
  }
4175
4176
  /**
4177
   * Case-sensitive string comparison.
4178
   *
4179
   * @param string $str1
4180
   * @param string $str2
4181
   *
4182 9
   * @return int  <p>
4183
   *              <strong>&lt; 0</strong> if str1 is less than str2<br />
4184 9
   *              <strong>&gt; 0</strong> if str1 is greater than str2<br />
4185 1
   *              <strong>0</strong> if they are equal.
4186
   *              </p>
4187
   */
4188 8
  public static function strcmp($str1, $str2)
4189 2
  {
4190 2
    /** @noinspection PhpUndefinedClassInspection */
4191
    return $str1 . '' === $str2 . '' ? 0 : strcmp(
4192 8
        \Normalizer::normalize($str1, \Normalizer::NFD),
4193 8
        \Normalizer::normalize($str2, \Normalizer::NFD)
4194 1
    );
4195
  }
4196
4197 7
  /**
4198
   * Find length of initial segment not matching mask.
4199 7
   *
4200
   * @param string $str
4201
   * @param string $charList
4202 1
   * @param int    $offset
4203
   * @param int    $length
4204
   *
4205
   * @return int|null
4206
   */
4207
  public static function strcspn($str, $charList, $offset = 0, $length = 2147483647)
4208
  {
4209
    if ('' === $charList .= '') {
4210
      return null;
4211
    }
4212
4213
    if ($offset || 2147483647 !== $length) {
4214
      $str = (string)self::substr($str, $offset, $length);
4215
    }
4216
4217
    $str = (string)$str;
4218 1
    if (!isset($str[0])) {
4219
      return null;
4220 1
    }
4221
4222
    if (preg_match('/^(.*?)' . self::rxClass($charList) . '/us', $str, $length)) {
4223
      /** @noinspection OffsetOperationsInspection */
4224
      return self::strlen($length[1]);
4225
    }
4226
4227
    return self::strlen($str);
4228
  }
4229
4230
  /**
4231
   * alias for "UTF8::stristr()"
4232 2
   *
4233
   * @see UTF8::stristr()
4234 2
   *
4235 2
   * @param string  $haystack
4236
   * @param string  $needle
4237 2
   * @param bool    $before_needle
4238 2
   * @param string  $encoding
4239 2
   * @param boolean $cleanUtf8
4240
   *
4241 2
   * @return string|false
4242 2
   */
4243
  public static function strichr($haystack, $needle, $before_needle = false, $encoding = 'UTF-8', $cleanUtf8 = false)
4244
  {
4245
    return self::stristr($haystack, $needle, $before_needle, $encoding, $cleanUtf8);
4246
  }
4247
4248
  /**
4249
   * Create a UTF-8 string from code points.
4250
   *
4251
   * INFO: opposite to UTF8::codepoints()
4252 3
   *
4253
   * @param array $array <p>Integer or Hexadecimal codepoints.</p>
4254 3
   *
4255 3
   * @return string <p>UTF-8 encoded string.</p>
4256 3
   */
4257
  public static function string(array $array)
4258 3
  {
4259
    return implode(
4260 3
        array_map(
4261
            array(
4262
                '\\voku\\helper\\UTF8',
4263
                'chr',
4264
            ),
4265
            $array
4266
        )
4267
    );
4268
  }
4269
4270
  /**
4271
   * Checks if string starts with "BOM" (Byte Order Mark Character) character.
4272
   *
4273
   * @param string $str <p>The input string.</p>
4274
   *
4275
   * @return bool <p><strong>true</strong> if the string has BOM at the start, <strong>false</strong> otherwise.</p>
4276
   */
4277
  public static function string_has_bom($str)
4278
  {
4279
    foreach (self::$bom as $bomString => $bomByteLength) {
4280
      if (0 === strpos($str, $bomString)) {
4281
        return true;
4282 2
      }
4283
    }
4284
4285 2
    return false;
4286
  }
4287 2
4288
  /**
4289
   * Strip HTML and PHP tags from a string + clean invalid UTF-8.
4290
   *
4291
   * @link http://php.net/manual/en/function.strip-tags.php
4292
   *
4293
   * @param string $str            <p>
4294
   *                               The input string.
4295
   *                               </p>
4296
   * @param string $allowable_tags [optional] <p>
4297
   *                               You can use the optional second parameter to specify tags which should
4298
   *                               not be stripped.
4299
   *                               </p>
4300
   *                               <p>
4301
   *                               HTML comments and PHP tags are also stripped. This is hardcoded and
4302
   *                               can not be changed with allowable_tags.
4303
   *                               </p>
4304
   *
4305
   * @return string <p>The stripped string.</p>
4306
   */
4307
  public static function strip_tags($str, $allowable_tags = null)
4308
  {
4309
    // clean broken utf8
4310
    $str = self::clean($str);
4311
4312
    return strip_tags($str, $allowable_tags);
4313
  }
4314 8
4315
  /**
4316 8
   * Finds position of first occurrence of a string within another, case insensitive.
4317 8
   *
4318
   * @link http://php.net/manual/en/function.mb-stripos.php
4319 8
   *
4320 3
   * @param string  $haystack  <p>
4321
   *                           The string from which to get the position of the first occurrence
4322
   *                           of needle
4323 7
   *                           </p>
4324 1
   * @param string  $needle    <p>
4325 1
   *                           The string to find in haystack
4326 1
   *                           </p>
4327
   * @param int     $offset    [optional] <p>
4328
   *                           The position in haystack
4329
   *                           to start searching
4330 7
   *                           </p>
4331 1
   * @param string  $encoding  [optional] <p>Set the charset for e.g. "\mb_" function.</p>
4332 7
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
4333 7
   *
4334 7
   * @return int|false <p>
4335
   *                   Return the numeric position of the first occurrence of needle in the haystack string,<br />
4336
   *                   or false if needle is not found.
4337
   *                   </p>
4338 7
   */
4339
  public static function stripos($haystack, $needle, $offset = null, $encoding = 'UTF-8', $cleanUtf8 = false)
4340
  {
4341
    $haystack = (string)$haystack;
4342
    $needle = (string)$needle;
4343
4344
    if (!isset($haystack[0], $needle[0])) {
4345
      return false;
4346
    }
4347
4348
    if ($cleanUtf8 === true) {
4349
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
4350
      // if invalid characters are found in $haystack before $needle
4351
      $haystack = self::clean($haystack);
4352
      $needle = self::clean($needle);
4353
    }
4354
4355 8 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...
4356
        $encoding === 'UTF-8'
4357 8
        ||
4358 2
        $encoding === true || $encoding === false // INFO: the "bool"-check is only a fallback for old versions
4359
    ) {
4360
      $encoding = 'UTF-8';
4361 6
    } else {
4362
      $encoding = self::normalize_encoding($encoding);
4363
    }
4364
4365 6
    return \mb_stripos($haystack, $needle, $offset, $encoding);
4366
  }
4367
4368
  /**
4369
   * Returns all of haystack starting from and including the first occurrence of needle to the end.
4370
   *
4371
   * @param string  $haystack      <p>The input string. Must be valid UTF-8.</p>
4372 6
   * @param string  $needle        <p>The string to look for. Must be valid UTF-8.</p>
4373
   * @param bool    $before_needle [optional] <p>
4374
   *                               If <b>TRUE</b>, grapheme_strstr() returns the part of the
4375
   *                               haystack before the first occurrence of the needle (excluding the needle).
4376
   *                               </p>
4377
   * @param string  $encoding      [optional] <p>Set the charset for e.g. "\mb_" function</p>
4378
   * @param boolean $cleanUtf8     [optional] <p>Clean non UTF-8 chars from the string.</p>
4379
   *
4380
   * @return false|string A sub-string,<br />or <strong>false</strong> if needle is not found.
4381
   */
4382
  public static function stristr($haystack, $needle, $before_needle = false, $encoding = 'UTF-8', $cleanUtf8 = false)
4383
  {
4384
    if ('' === $needle .= '') {
4385
      return false;
4386
    }
4387 62
4388
    if ($encoding !== 'UTF-8') {
4389 62
      $encoding = self::normalize_encoding($encoding);
4390
    }
4391 62
4392 4
    if ($cleanUtf8 === true) {
4393
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
4394
      // if invalid characters are found in $haystack before $needle
4395
      $needle = self::clean($needle);
4396
      $haystack = self::clean($haystack);
4397 61
    }
4398 2
4399 61
    return \mb_stristr($haystack, $needle, $before_needle, $encoding);
4400 60
  }
4401 60
4402 2
  /**
4403
   * Get the string length, not the byte-length!
4404
   *
4405
   * @link     http://php.net/manual/en/function.mb-strlen.php
4406 61
   *
4407 61
   * @param string  $str       <p>The string being checked for length.</p>
4408 1
   * @param string  $encoding  [optional] <p>Set the charset for e.g. "\mb_" function.</p>
4409
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
4410
   *
4411 61
   * @return int <p>The number of characters in the string $str having character encoding $encoding. (One multi-byte
4412 2
   *             character counted as +1)</p>
4413 2
   */
4414
  public static function strlen($str, $encoding = 'UTF-8', $cleanUtf8 = false)
4415 61
  {
4416
    $str = (string)$str;
4417
4418
    if (!isset($str[0])) {
4419
      return 0;
4420
    }
4421
4422 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...
4423
        $encoding === 'UTF-8'
4424
        ||
4425
        $encoding === true || $encoding === false // INFO: the "bool"-check is only a fallback for old versions
4426
    ) {
4427
      $encoding = 'UTF-8';
4428
    } else {
4429
      $encoding = self::normalize_encoding($encoding);
4430 1
    }
4431
4432 1
    switch ($encoding) {
4433
      case 'ASCII':
4434
      case 'CP850':
4435
        return strlen($str);
4436
    }
4437
4438
    if ($cleanUtf8 === true) {
4439
      $str = self::clean($str);
4440
    }
4441
4442
    return \mb_strlen($str, $encoding);
4443
  }
4444
4445
  /**
4446
   * Case insensitive string comparisons using a "natural order" algorithm.
4447
   *
4448
   * INFO: natural order version of UTF8::strcasecmp()
4449 2
   *
4450
   * @param string $str1 <p>The first string.</p>
4451 2
   * @param string $str2 <p>The second string.</p>
4452
   *
4453
   * @return int <strong>&lt; 0</strong> if str1 is less than str2<br />
4454
   *             <strong>&gt; 0</strong> if str1 is greater than str2<br />
4455
   *             <strong>0</strong> if they are equal
4456
   */
4457
  public static function strnatcasecmp($str1, $str2)
4458
  {
4459
    return self::strnatcmp(self::strtocasefold($str1), self::strtocasefold($str2));
4460
  }
4461
4462
  /**
4463
   * String comparisons using a "natural order" algorithm
4464
   *
4465
   * INFO: natural order version of UTF8::strcmp()
4466
   *
4467 1
   * @link  http://php.net/manual/en/function.strnatcmp.php
4468
   *
4469 1
   * @param string $str1 <p>The first string.</p>
4470
   * @param string $str2 <p>The second string.</p>
4471
   *
4472
   * @return int <strong>&lt; 0</strong> if str1 is less than str2;<br />
4473
   *             <strong>&gt; 0</strong> if str1 is greater than str2;<br />
4474
   *             <strong>0</strong> if they are equal
4475
   */
4476
  public static function strnatcmp($str1, $str2)
4477
  {
4478
    return $str1 . '' === $str2 . '' ? 0 : strnatcmp(self::strtonatfold($str1), self::strtonatfold($str2));
4479
  }
4480
4481
  /**
4482
   * Case-insensitive string comparison of the first n characters.
4483
   *
4484
   * @link  http://php.net/manual/en/function.strncasecmp.php
4485 2
   *
4486
   * @param string $str1 <p>The first string.</p>
4487 2
   * @param string $str2 <p>The second string.</p>
4488 2
   * @param int    $len  <p>The length of strings to be used in the comparison.</p>
4489
   *
4490 2
   * @return int <strong>&lt; 0</strong> if <i>str1</i> is less than <i>str2</i>;<br />
4491
   *             <strong>&gt; 0</strong> if <i>str1</i> is greater than <i>str2</i>;<br />
4492
   *             <strong>0</strong> if they are equal
4493
   */
4494
  public static function strncasecmp($str1, $str2, $len)
4495
  {
4496
    return self::strncmp(self::strtocasefold($str1), self::strtocasefold($str2), $len);
4497
  }
4498
4499
  /**
4500
   * String comparison of the first n characters.
4501
   *
4502
   * @link  http://php.net/manual/en/function.strncmp.php
4503 1
   *
4504
   * @param string $str1 <p>The first string.</p>
4505 1
   * @param string $str2 <p>The second string.</p>
4506 1
   * @param int    $len  <p>Number of characters to use in the comparison.</p>
4507
   *
4508 1
   * @return int <strong>&lt; 0</strong> if <i>str1</i> is less than <i>str2</i>;<br />
4509 1
   *             <strong>&gt; 0</strong> if <i>str1</i> is greater than <i>str2</i>;<br />
4510
   *             <strong>0</strong> if they are equal
4511
   */
4512 1
  public static function strncmp($str1, $str2, $len)
4513 1
  {
4514
    $str1 = self::substr($str1, 0, $len);
4515 1
    $str2 = self::substr($str2, 0, $len);
4516
4517
    return self::strcmp($str1, $str2);
0 ignored issues
show
Security Bug introduced by
It seems like $str1 defined by self::substr($str1, 0, $len) on line 4514 can also be of type false; however, voku\helper\UTF8::strcmp() does only seem to accept string, did you maybe forget to handle an error condition?

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

Consider the follow example

<?php

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

    return false;
}

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

Loading history...
Security Bug introduced by
It seems like $str2 defined by self::substr($str2, 0, $len) on line 4515 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...
4518
  }
4519
4520
  /**
4521
   * Search a string for any of a set of characters.
4522
   *
4523
   * @link  http://php.net/manual/en/function.strpbrk.php
4524
   *
4525
   * @param string $haystack  <p>The string where char_list is looked for.</p>
4526
   * @param string $char_list <p>This parameter is case sensitive.</p>
4527
   *
4528
   * @return string String starting from the character found, or false if it is not found.
4529
   */
4530
  public static function strpbrk($haystack, $char_list)
4531
  {
4532
    $haystack = (string)$haystack;
4533
    $char_list = (string)$char_list;
4534
4535 15
    if (!isset($haystack[0], $char_list[0])) {
4536
      return false;
4537 15
    }
4538 15
4539
    if (preg_match('/' . self::rxClass($char_list) . '/us', $haystack, $m)) {
4540 15
      return substr($haystack, strpos($haystack, $m[0]));
4541 2
    } else {
4542
      return false;
4543
    }
4544
  }
4545 14
4546
  /**
4547
   * Find position of first occurrence of string in a string.
4548
   *
4549 14
   * @link http://php.net/manual/en/function.mb-strpos.php
4550
   *
4551
   * @param string  $haystack  <p>The string being checked.</p>
4552
   * @param string  $needle    <p>The position counted from the beginning of haystack.</p>
4553 14
   * @param int     $offset    [optional] <p>The search offset. If it is not specified, 0 is used.</p>
4554
   * @param string  $encoding  [optional] <p>Set the charset for e.g. "\mb_" function.</p>
4555
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
4556 2
   *
4557 2
   * @return int|false <p>
4558 2
   *                   The numeric position of the first occurrence of needle in the haystack string.<br />
4559
   *                   If needle is not found it returns false.
4560 14
   *                   </p>
4561
   */
4562
  public static function strpos($haystack, $needle, $offset = 0, $encoding = 'UTF-8', $cleanUtf8 = false)
4563
  {
4564
    $haystack = (string)$haystack;
4565
    $needle = (string)$needle;
4566 14
4567 2
    if (!isset($haystack[0], $needle[0])) {
4568 14
      return false;
4569 14
    }
4570 14
4571 1
    // init
4572
    $offset = (int)$offset;
4573
4574 14
    // iconv and mbstring do not support integer $needle
4575 14
4576
    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...
4577
      $needle = (string)self::chr($needle);
4578
    }
4579
4580
    if ($cleanUtf8 === true) {
4581
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
4582
      // if invalid characters are found in $haystack before $needle
4583
      $needle = self::clean($needle);
4584
      $haystack = self::clean($haystack);
4585
    }
4586
4587
    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
4588
      self::checkForSupport();
4589
    }
4590
4591 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...
4592
        $encoding === 'UTF-8'
4593
        ||
4594
        $encoding === true || $encoding === false // INFO: the "bool"-check is only a fallback for old versions
4595
    ) {
4596
      $encoding = 'UTF-8';
4597
    } else {
4598
      $encoding = self::normalize_encoding($encoding);
4599
    }
4600
4601
    if (self::$support['mbstring'] === true) {
4602
      return \mb_strpos($haystack, $needle, $offset, $encoding);
4603
    }
4604
4605
    if (self::$support['iconv'] === true) {
4606
      // ignore invalid negative offset to keep compatibility
4607
      // 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...
4608
      return \iconv_strpos($haystack, $needle, $offset > 0 ? $offset : 0, $encoding);
4609
    }
4610
4611
    if ($offset > 0) {
4612
      $haystack = self::substr($haystack, $offset);
4613
    }
4614
4615 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...
4616
      $left = substr($haystack, 0, $pos);
4617
4618
      // negative offset not supported in PHP strpos(), ignoring
4619
      return ($offset > 0 ? $offset : 0) + self::strlen($left);
4620 1
    }
4621
4622 1
    return false;
4623 1
  }
4624 1
4625
  /**
4626 1
   * Finds the last occurrence of a character in a string within another.
4627
   *
4628
   * @link http://php.net/manual/en/function.mb-strrchr.php
4629
   *
4630
   * @param string $haystack      <p>The string from which to get the last occurrence of needle.</p>
4631
   * @param string $needle        <p>The string to find in haystack</p>
4632
   * @param bool   $before_needle [optional] <p>
4633 1
   *                              Determines which portion of haystack
4634
   *                              this function returns.
4635
   *                              If set to true, it returns all of haystack
4636
   *                              from the beginning to the last occurrence of needle.
4637
   *                              If set to false, it returns all of haystack
4638
   *                              from the last occurrence of needle to the end,
4639
   *                              </p>
4640
   * @param string $encoding      [optional] <p>
4641
   *                              Character encoding name to use.
4642
   *                              If it is omitted, internal character encoding is used.
4643 4
   *                              </p>
4644
   * @param bool   $cleanUtf8     [optional] <p>Clean non UTF-8 chars from the string.</p>
4645 4
   *
4646
   * @return string|false The portion of haystack or false if needle is not found.
4647 4
   */
4648 2 View Code Duplication
  public static function strrchr($haystack, $needle, $before_needle = false, $encoding = 'UTF-8', $cleanUtf8 = false)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

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

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

Loading history...
4649
  {
4650
    if ($encoding !== 'UTF-8') {
4651 3
      $encoding = self::normalize_encoding($encoding);
4652
    }
4653
4654
    if ($cleanUtf8 === true) {
4655
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
4656
      // if invalid characters are found in $haystack before $needle
4657
      $needle = self::clean($needle);
4658
      $haystack = self::clean($haystack);
4659
    }
4660
4661
    return \mb_strrchr($haystack, $needle, $before_needle, $encoding);
4662
  }
4663
4664
  /**
4665
   * Reverses characters order in the string.
4666
   *
4667
   * @param string $str The input string
4668
   *
4669
   * @return string The string with characters in the reverse sequence
4670
   */
4671
  public static function strrev($str)
4672
  {
4673
    $str = (string)$str;
4674
4675
    if (!isset($str[0])) {
4676
      return '';
4677 1
    }
4678
4679 1
    return implode(array_reverse(self::split($str)));
4680 1
  }
4681 1
4682
  /**
4683 1
   * Finds the last occurrence of a character in a string within another, case insensitive.
4684
   *
4685
   * @link http://php.net/manual/en/function.mb-strrichr.php
4686
   *
4687
   * @param string  $haystack      <p>The string from which to get the last occurrence of needle.</p>
4688
   * @param string  $needle        <p>The string to find in haystack.</p>
4689
   * @param bool    $before_needle [optional] <p>
4690 1
   *                               Determines which portion of haystack
4691
   *                               this function returns.
4692
   *                               If set to true, it returns all of haystack
4693
   *                               from the beginning to the last occurrence of needle.
4694
   *                               If set to false, it returns all of haystack
4695
   *                               from the last occurrence of needle to the end,
4696
   *                               </p>
4697
   * @param string  $encoding      [optional] <p>
4698
   *                               Character encoding name to use.
4699
   *                               If it is omitted, internal character encoding is used.
4700
   *                               </p>
4701
   * @param boolean $cleanUtf8     [optional] <p>Clean non UTF-8 chars from the string.</p>
4702
   *
4703
   * @return string|false <p>The portion of haystack or<br />false if needle is not found.</p>
4704
   */
4705 View Code Duplication
  public static function strrichr($haystack, $needle, $before_needle = false, $encoding = 'UTF-8', $cleanUtf8 = false)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

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

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

Loading history...
4706
  {
4707 1
    if ($encoding !== 'UTF-8') {
4708
      $encoding = self::normalize_encoding($encoding);
4709 1
    }
4710
4711
    if ($cleanUtf8 === true) {
4712
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
4713
      // if invalid characters are found in $haystack before $needle
4714
      $needle = self::clean($needle);
4715
      $haystack = self::clean($haystack);
4716
    }
4717
4718
    return \mb_strrichr($haystack, $needle, $before_needle, $encoding);
4719
  }
4720
4721
  /**
4722
   * Find position of last occurrence of a case-insensitive string.
4723
   *
4724
   * @param string  $haystack  <p>The string to look in.</p>
4725
   * @param string  $needle    <p>The string to look for.</p>
4726
   * @param int     $offset    [optional] <p>Number of characters to ignore in the beginning or end.</p>
4727
   * @param string  $encoding  [optional] <p>Set the charset for e.g. "\mb_" function.</p>
4728
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
4729 11
   *
4730
   * @return int|false <p>
4731 11
   *                   The numeric position of the last occurrence of needle in the haystack string.<br />If needle is
4732
   *                   not found, it returns false.
4733 11
   *                   </p>
4734 2
   */
4735 2
  public static function strripos($haystack, $needle, $offset = 0, $encoding = 'UTF-8', $cleanUtf8 = false)
4736
  {
4737 11
    return self::strrpos(self::strtolower($haystack), self::strtolower($needle), $offset, $encoding, $cleanUtf8);
4738
  }
4739 11
4740 2
  /**
4741
   * Find position of last occurrence of a string in a string.
4742
   *
4743
   * @link http://php.net/manual/en/function.mb-strrpos.php
4744 10
   *
4745 10
   * @param string     $haystack  <p>The string being checked, for the last occurrence of needle</p>
4746
   * @param string|int $needle    <p>The string to find in haystack.<br />Or a code point as int.</p>
4747
   * @param int        $offset    [optional] <p>May be specified to begin searching an arbitrary number of characters
4748
   *                              into the string. Negative values will stop searching at an arbitrary point prior to
4749 10
   *                              the end of the string.
4750
   *                              </p>
4751 10
   * @param string     $encoding  [optional] <p>Set the charset for e.g. "\mb_" function.</p>
4752
   * @param boolean    $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
4753
   *
4754 3
   * @return int|false <p>The numeric position of the last occurrence of needle in the haystack string.<br />If needle
4755 3
   *                   is not found, it returns false.</p>
4756 3
   */
4757
  public static function strrpos($haystack, $needle, $offset = null, $encoding = 'UTF-8', $cleanUtf8 = false)
4758 10
  {
4759
    if (((int)$needle) === $needle && ($needle >= 0)) {
4760
      $needle = (string)self::chr($needle);
4761
    }
4762
4763
    $haystack = (string)$haystack;
4764 10
    $needle = (string)$needle;
4765 1
4766 10
    if (!isset($haystack[0], $needle[0])) {
4767 10
      return false;
4768 10
    }
4769 1
4770
    // init
4771
    $needle = (string)$needle;
4772
    $offset = (int)$offset;
4773
4774 10
    if (
4775 10
        $cleanUtf8 === true
4776 10
        ||
4777 10
        $encoding === true // INFO: the "bool"-check is only a fallback for old versions
4778
    ) {
4779
      // \mb_strrpos && iconv_strrpos is not tolerant to invalid characters
4780
4781
      $needle = self::clean($needle);
4782
      $haystack = self::clean($haystack);
4783
    }
4784
4785
    if (!isset(self::$support['already_checked_via_portable_utf8'])) {
4786
      self::checkForSupport();
4787
    }
4788
4789 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...
4790
        $encoding === 'UTF-8'
4791
        ||
4792
        $encoding === true || $encoding === false // INFO: the "bool"-check is only a fallback for old versions
4793
    ) {
4794
      $encoding = 'UTF-8';
4795
    } else {
4796
      $encoding = self::normalize_encoding($encoding);
4797
    }
4798
4799
    if (
4800
        $encoding !== 'UTF-8' // INFO: use "mb_"-function (with polyfill) also if we need another encoding
4801
        ||
4802
        self::$support['mbstring'] === true
4803
    ) {
4804
      return \mb_strrpos($haystack, $needle, $offset, $encoding);
4805
    }
4806
4807
    if (self::$support['iconv'] === true) {
4808
      return \grapheme_strrpos($haystack, $needle, $offset);
4809
    }
4810
4811
    // fallback
4812
4813 10
    if ($offset > 0) {
4814
      $haystack = self::substr($haystack, $offset);
4815
    } elseif ($offset < 0) {
4816 10
      $haystack = self::substr($haystack, 0, $offset);
4817 10
    }
4818
4819 10 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...
4820 2
      $left = substr($haystack, 0, $pos);
4821 2
4822
      // negative offset not supported in PHP strpos(), ignoring
4823 10
      return ($offset > 0 ? $offset : 0) + self::strlen($left);
4824 10
    }
4825 2
4826
    return false;
4827
  }
4828 8
4829
  /**
4830
   * Finds the length of the initial segment of a string consisting entirely of characters contained within a given
4831
   * mask.
4832
   *
4833
   * @param string $str    <p>The input string.</p>
4834
   * @param string $mask   <p>The mask of chars</p>
4835
   * @param int    $offset [optional]
4836
   * @param int    $length [optional]
4837
   *
4838
   * @return int
4839
   */
4840
  public static function strspn($str, $mask, $offset = 0, $length = 2147483647)
4841
  {
4842
    // init
4843
    $length = (int)$length;
4844
    $offset = (int)$offset;
4845 2
4846
    if ($offset || 2147483647 !== $length) {
4847 2
      $str = self::substr($str, $offset, $length);
4848
    }
4849
4850
    $str = (string)$str;
4851
    if (!isset($str[0], $mask[0])) {
4852
      return 0;
4853
    }
4854 2
4855 1
    return preg_match('/^' . self::rxClass($mask) . '+/u', $str, $str) ? self::strlen($str[0]) : 0;
4856 1
  }
4857
4858
  /**
4859
   * Returns part of haystack string from the first occurrence of needle to the end of haystack.
4860 2
   *
4861 2
   * @param string  $haystack      <p>The input string. Must be valid UTF-8.</p>
4862 2
   * @param string  $needle        <p>The string to look for. Must be valid UTF-8.</p>
4863 2
   * @param bool    $before_needle [optional] <p>
4864
   *                               If <b>TRUE</b>, strstr() returns the part of the
4865
   *                               haystack before the first occurrence of the needle (excluding the needle).
4866
   *                               </p>
4867
   * @param string  $encoding      [optional] <p>Set the charset for e.g. "\mb_" function.</p>
4868
   * @param boolean $cleanUtf8     [optional] <p>Clean non UTF-8 chars from the string.</p>
4869
   *
4870
   * @return string|false A sub-string,<br />or <strong>false</strong> if needle is not found.
4871
   */
4872
  public static function strstr($haystack, $needle, $before_needle = false, $encoding = 'UTF-8', $cleanUtf8 = false)
4873
  {
4874
    if ($cleanUtf8 === true) {
4875
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
4876
      // if invalid characters are found in $haystack before $needle
4877
      $needle = self::clean($needle);
4878
      $haystack = self::clean($haystack);
4879
    }
4880
4881
    if ($encoding !== 'UTF-8') {
4882 11
      $encoding = self::normalize_encoding($encoding);
4883
    }
4884 11
4885 11
    if (
4886 11
        $encoding !== 'UTF-8' // INFO: use "mb_"-function (with polyfill) also if we need another encoding
4887
        ||
4888 11
        self::$support['mbstring'] === true
4889 1
    ) {
4890 1
      return \mb_strstr($haystack, $needle, $before_needle, $encoding);
4891 1
    }
4892
4893 11
    return \grapheme_strstr($haystack, $needle, $before_needle);
4894
  }
4895 11
4896
  /**
4897 11
   * Unicode transformation for case-less matching.
4898 1
   *
4899 1
   * @link http://unicode.org/reports/tr21/tr21-5.html
4900
   *
4901
   * @param string  $str       <p>The input string.</p>
4902 11
   * @param bool    $full      [optional] <p>
4903 11
   *                           <b>true</b>, replace full case folding chars (default)<br />
4904
   *                           <b>false</b>, use only limited static array [UTF8::$commonCaseFold]
4905 11
   *                           </p>
4906
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
4907 11
   *
4908
   * @return string
4909
   */
4910
  public static function strtocasefold($str, $full = true, $cleanUtf8 = false)
4911
  {
4912
    // init
4913
    $str = (string)$str;
4914
4915
    if (!isset($str[0])) {
4916
      return '';
4917
    }
4918
4919
    static $commonCaseFoldKeys = null;
4920
    static $commonCaseFoldValues = null;
4921 21
4922
    if ($commonCaseFoldKeys === null) {
4923
      $commonCaseFoldKeys = array_keys(self::$commonCaseFold);
4924 21
      $commonCaseFoldValues = array_values(self::$commonCaseFold);
4925
    }
4926 21
4927 6
    $str = str_replace($commonCaseFoldKeys, $commonCaseFoldValues, $str);
4928
4929
    if ($full) {
4930 19
4931
      static $fullCaseFold = null;
4932
4933
      if ($fullCaseFold === null) {
4934
        $fullCaseFold = self::getData('caseFolding_full');
4935
      }
4936 19
4937 2
      /** @noinspection OffsetOperationsInspection */
4938 2
      $str = str_replace($fullCaseFold[0], $fullCaseFold[1], $str);
4939
    }
4940 19
4941
    if ($cleanUtf8 === true) {
4942
      $str = self::clean($str);
4943
    }
4944
4945
    return self::strtolower($str);
4946
  }
4947
4948
  /**
4949
   * Make a string lowercase.
4950 3
   *
4951
   * @link http://php.net/manual/en/function.mb-strtolower.php
4952 3
   *
4953
   * @param string  $str       <p>The string being lowercased.</p>
4954
   * @param string  $encoding  [optional] <p>Set the charset for e.g. "\mb_" function</p>
4955
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
4956
   *
4957
   * @return string str with all alphabetic characters converted to lowercase.
4958
   */
4959 View Code Duplication
  public static function strtolower($str, $encoding = 'UTF-8', $cleanUtf8 = false)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

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

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

Loading history...
4960
  {
4961
    // init
4962
    $str = (string)$str;
4963
4964
    if (!isset($str[0])) {
4965
      return '';
4966 16
    }
4967
4968 16
    if ($cleanUtf8 === true) {
4969
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
4970 16
      // if invalid characters are found in $haystack before $needle
4971 2
      $str = self::clean($str);
4972
    }
4973
4974 15
    if ($encoding !== 'UTF-8') {
4975
      $encoding = self::normalize_encoding($encoding);
4976
    }
4977
4978
    return \mb_strtolower($str, $encoding);
4979
  }
4980 15
4981 2
  /**
4982 2
   * Generic case sensitive transformation for collation matching.
4983
   *
4984 15
   * @param string $str <p>The input string</p>
4985
   *
4986
   * @return string
4987
   */
4988
  private static function strtonatfold($str)
4989
  {
4990
    /** @noinspection PhpUndefinedClassInspection */
4991
    return preg_replace('/\p{Mn}+/u', '', \Normalizer::normalize($str, \Normalizer::NFD));
4992
  }
4993
4994
  /**
4995
   * Make a string uppercase.
4996
   *
4997
   * @link http://php.net/manual/en/function.mb-strtoupper.php
4998
   *
4999
   * @param string  $str       <p>The string being uppercased.</p>
5000
   * @param string  $encoding  [optional] <p>Set the charset for e.g. "\mb_" function.</p>
5001 1
   * @param boolean $cleanUtf8 [optional] <p>Clean non UTF-8 chars from the string.</p>
5002
   *
5003 1
   * @return string str with all alphabetic characters converted to uppercase.
5004 1
   */
5005 1 View Code Duplication
  public static function strtoupper($str, $encoding = 'UTF-8', $cleanUtf8 = false)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

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

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

Loading history...
5006 1
  {
5007 1
    $str = (string)$str;
5008
5009 1
    if (!isset($str[0])) {
5010 1
      return '';
5011 1
    }
5012 1
5013 1
    if ($cleanUtf8 === true) {
5014
      // "\mb_strpos" and "\iconv_strpos" returns wrong position,
5015 1
      // if invalid characters are found in $haystack before $needle
5016 1
      $str = self::clean($str);
5017
    }
5018 1
5019
    if ($encoding !== 'UTF-8') {
5020
      $encoding = self::normalize_encoding($encoding);
5021
    }
5022
5023
    return \mb_strtoupper($str, $encoding);
5024
  }
5025
5026
  /**
5027
   * Translate characters or replace sub-strings.
5028
   *
5029
   * @link  http://php.net/manual/en/function.strtr.php
5030 1
   *
5031
   * @param string          $str  <p>The string being translated.</p>
5032 1
   * @param string|string[] $from <p>The string replacing from.</p>
5033 1
   * @param string|string[] $to   <p>The string being translated to to.</p>
5034 1
   *
5035
   * @return string <p>
5036 1
   *                This function returns a copy of str, translating all occurrences of each character in from to the
5037
   *                corresponding character in to.
5038
   *                </p>
5039
   */
5040 1
  public static function strtr($str, $from, $to = INF)
5041 1
  {
5042
    if (INF !== $to) {
5043 1
      $from = self::str_split($from);
0 ignored issues
show
Bug introduced by
It seems like $from defined by self::str_split($from) on line 5043 can also be of type array<integer,string>; however, voku\helper\UTF8::str_split() does only seem to accept string, maybe add an additional type check?

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

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

    return array();
}

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

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

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

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

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

    return array();
}

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

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

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