• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

nette / utils / 12277622433

11 Dec 2024 01:39PM UTC coverage: 92.269% (+0.007%) from 92.262%
12277622433

push

github

dg
added Process [WIP]

2017 of 2186 relevant lines covered (92.27%)

0.92 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

89.34
/src/Utils/Strings.php
1
<?php
2

3
/**
4
 * This file is part of the Nette Framework (https://nette.org)
5
 * Copyright (c) 2004 David Grudl (https://davidgrudl.com)
6
 */
7

8
declare(strict_types=1);
9

10
namespace Nette\Utils;
11

12
use JetBrains\PhpStorm\Language;
13
use Nette;
14
use function is_array, is_object, strlen;
15

16

17
/**
18
 * String tools library.
19
 */
20
class Strings
21
{
22
        use Nette\StaticClass;
23

24
        public const TrimCharacters = " \t\n\r\0\x0B\u{A0}\u{2000}\u{2001}\u{2002}\u{2003}\u{2004}\u{2005}\u{2006}\u{2007}\u{2008}\u{2009}\u{200A}\u{200B}";
25

26
        /** @deprecated use Strings::TrimCharacters */
27
        public const TRIM_CHARACTERS = self::TrimCharacters;
28

29

30
        /**
31
         * @deprecated use Nette\Utils\Validator::isUnicode()
32
         */
33
        public static function checkEncoding(string $s): bool
1✔
34
        {
35
                return $s === self::fixEncoding($s);
1✔
36
        }
37

38

39
        /**
40
         * Removes all invalid UTF-8 characters from a string.
41
         */
42
        public static function fixEncoding(string $s): string
1✔
43
        {
44
                // removes xD800-xDFFF, x110000 and higher
45
                return htmlspecialchars_decode(htmlspecialchars($s, ENT_NOQUOTES | ENT_IGNORE, 'UTF-8'), ENT_NOQUOTES);
1✔
46
        }
47

48

49
        /**
50
         * Returns a specific character in UTF-8 from code point (number in range 0x0000..D7FF or 0xE000..10FFFF).
51
         * @throws Nette\InvalidArgumentException if code point is not in valid range
52
         */
53
        public static function chr(int $code): string
1✔
54
        {
55
                if ($code < 0 || ($code >= 0xD800 && $code <= 0xDFFF) || $code > 0x10FFFF) {
1✔
56
                        throw new Nette\InvalidArgumentException('Code point must be in range 0x0 to 0xD7FF or 0xE000 to 0x10FFFF.');
1✔
57
                } elseif (!extension_loaded('iconv')) {
1✔
58
                        throw new Nette\NotSupportedException(__METHOD__ . '() requires ICONV extension that is not loaded.');
×
59
                }
60

61
                return iconv('UTF-32BE', 'UTF-8//IGNORE', pack('N', $code));
1✔
62
        }
63

64

65
        /**
66
         * Returns a code point of specific character in UTF-8 (number in range 0x0000..D7FF or 0xE000..10FFFF).
67
         */
68
        public static function ord(string $c): int
1✔
69
        {
70
                if (!extension_loaded('iconv')) {
1✔
71
                        throw new Nette\NotSupportedException(__METHOD__ . '() requires ICONV extension that is not loaded.');
×
72
                }
73

74
                $tmp = iconv('UTF-8', 'UTF-32BE//IGNORE', $c);
1✔
75
                if (!$tmp) {
1✔
76
                        throw new Nette\InvalidArgumentException('Invalid UTF-8 character "' . ($c === '' ? '' : '\x' . strtoupper(bin2hex($c))) . '".');
1✔
77
                }
78

79
                return unpack('N', $tmp)[1];
1✔
80
        }
81

82

83
        /**
84
         * @deprecated use str_starts_with()
85
         */
86
        public static function startsWith(string $haystack, string $needle): bool
1✔
87
        {
88
                return str_starts_with($haystack, $needle);
1✔
89
        }
90

91

92
        /**
93
         * @deprecated use str_ends_with()
94
         */
95
        public static function endsWith(string $haystack, string $needle): bool
1✔
96
        {
97
                return str_ends_with($haystack, $needle);
1✔
98
        }
99

100

101
        /**
102
         * @deprecated use str_contains()
103
         */
104
        public static function contains(string $haystack, string $needle): bool
1✔
105
        {
106
                return str_contains($haystack, $needle);
1✔
107
        }
108

109

110
        /**
111
         * Returns a part of UTF-8 string specified by starting position and length. If start is negative,
112
         * the returned string will start at the start'th character from the end of string.
113
         */
114
        public static function substring(string $s, int $start, ?int $length = null): string
1✔
115
        {
116
                if (function_exists('mb_substr')) {
1✔
117
                        return mb_substr($s, $start, $length, 'UTF-8'); // MB is much faster
1✔
118
                } elseif (!extension_loaded('iconv')) {
×
119
                        throw new Nette\NotSupportedException(__METHOD__ . '() requires extension ICONV or MBSTRING, neither is loaded.');
×
120
                } elseif ($length === null) {
×
121
                        $length = self::length($s);
×
122
                } elseif ($start < 0 && $length < 0) {
×
123
                        $start += self::length($s); // unifies iconv_substr behavior with mb_substr
×
124
                }
125

126
                return iconv_substr($s, $start, $length, 'UTF-8');
×
127
        }
128

129

130
        /**
131
         * Removes control characters, normalizes line breaks to `\n`, removes leading and trailing blank lines,
132
         * trims end spaces on lines, normalizes UTF-8 to the normal form of NFC.
133
         */
134
        public static function normalize(string $s): string
1✔
135
        {
136
                // convert to compressed normal form (NFC)
137
                if (class_exists('Normalizer', false) && ($n = \Normalizer::normalize($s, \Normalizer::FORM_C)) !== false) {
1✔
138
                        $s = $n;
1✔
139
                }
140

141
                $s = self::unixNewLines($s);
1✔
142

143
                // remove control characters; leave \t + \n
144
                $s = self::pcre('preg_replace', ['#[\x00-\x08\x0B-\x1F\x7F-\x9F]+#u', '', $s]);
1✔
145

146
                // right trim
147
                $s = self::pcre('preg_replace', ['#[\t ]+$#m', '', $s]);
1✔
148

149
                // leading and trailing blank lines
150
                $s = trim($s, "\n");
1✔
151

152
                return $s;
1✔
153
        }
154

155

156
        /** @deprecated use Strings::unixNewLines() */
157
        public static function normalizeNewLines(string $s): string
1✔
158
        {
159
                return self::unixNewLines($s);
1✔
160
        }
161

162

163
        /**
164
         * Converts line endings to \n used on Unix-like systems.
165
         * Line endings are: \n, \r, \r\n, U+2028 line separator, U+2029 paragraph separator.
166
         */
167
        public static function unixNewLines(string $s): string
1✔
168
        {
169
                return preg_replace("~\r\n?|\u{2028}|\u{2029}~", "\n", $s);
1✔
170
        }
171

172

173
        /**
174
         * Converts line endings to platform-specific, i.e. \r\n on Windows and \n elsewhere.
175
         * Line endings are: \n, \r, \r\n, U+2028 line separator, U+2029 paragraph separator.
176
         */
177
        public static function platformNewLines(string $s): string
1✔
178
        {
179
                return preg_replace("~\r\n?|\n|\u{2028}|\u{2029}~", PHP_EOL, $s);
1✔
180
        }
181

182

183
        /**
184
         * Converts UTF-8 string to ASCII, ie removes diacritics etc.
185
         */
186
        public static function toAscii(string $s): string
1✔
187
        {
188
                $iconv = defined('ICONV_IMPL') ? trim(ICONV_IMPL, '"\'') : null;
1✔
189
                static $transliterator = null;
1✔
190
                if ($transliterator === null) {
1✔
191
                        if (class_exists('Transliterator', false)) {
1✔
192
                                $transliterator = \Transliterator::create('Any-Latin; Latin-ASCII');
1✔
193
                        } else {
194
                                trigger_error(__METHOD__ . "(): it is recommended to enable PHP extensions 'intl'.", E_USER_NOTICE);
×
195
                                $transliterator = false;
×
196
                        }
197
                }
198

199
                // remove control characters and check UTF-8 validity
200
                $s = self::pcre('preg_replace', ['#[^\x09\x0A\x0D\x20-\x7E\xA0-\x{2FF}\x{370}-\x{10FFFF}]#u', '', $s]);
1✔
201

202
                // transliteration (by Transliterator and iconv) is not optimal, replace some characters directly
203
                $s = strtr($s, ["\u{201E}" => '"', "\u{201C}" => '"', "\u{201D}" => '"', "\u{201A}" => "'", "\u{2018}" => "'", "\u{2019}" => "'", "\u{B0}" => '^', "\u{42F}" => 'Ya', "\u{44F}" => 'ya', "\u{42E}" => 'Yu', "\u{44E}" => 'yu', "\u{c4}" => 'Ae', "\u{d6}" => 'Oe', "\u{dc}" => 'Ue', "\u{1e9e}" => 'Ss', "\u{e4}" => 'ae', "\u{f6}" => 'oe', "\u{fc}" => 'ue', "\u{df}" => 'ss']); // „ “ ” ‚ ‘ ’ ° Я я Ю ю Ä Ö Ü ẞ ä ö ü ß
1✔
204
                if ($iconv !== 'libiconv') {
1✔
205
                        $s = strtr($s, ["\u{AE}" => '(R)', "\u{A9}" => '(c)', "\u{2026}" => '...', "\u{AB}" => '<<', "\u{BB}" => '>>', "\u{A3}" => 'lb', "\u{A5}" => 'yen', "\u{B2}" => '^2', "\u{B3}" => '^3', "\u{B5}" => 'u', "\u{B9}" => '^1', "\u{BA}" => 'o', "\u{BF}" => '?', "\u{2CA}" => "'", "\u{2CD}" => '_', "\u{2DD}" => '"', "\u{1FEF}" => '', "\u{20AC}" => 'EUR', "\u{2122}" => 'TM', "\u{212E}" => 'e', "\u{2190}" => '<-', "\u{2191}" => '^', "\u{2192}" => '->', "\u{2193}" => 'V', "\u{2194}" => '<->']); // ® © … « » £ ¥ ² ³ µ ¹ º ¿ ˊ ˍ ˝ ` € ™ ℮ ← ↑ → ↓ ↔
1✔
206
                }
207

208
                if ($transliterator) {
1✔
209
                        $s = $transliterator->transliterate($s);
1✔
210
                        // use iconv because The transliterator leaves some characters out of ASCII, eg → ʾ
211
                        if ($iconv === 'glibc') {
1✔
212
                                $s = strtr($s, '?', "\x01"); // temporarily hide ? to distinguish them from the garbage that iconv creates
1✔
213
                                $s = iconv('UTF-8', 'ASCII//TRANSLIT//IGNORE', $s);
1✔
214
                                $s = str_replace(['?', "\x01"], ['', '?'], $s); // remove garbage and restore ? characters
1✔
215
                        } elseif ($iconv === 'libiconv') {
×
216
                                $s = iconv('UTF-8', 'ASCII//TRANSLIT//IGNORE', $s);
×
217
                        } else { // null or 'unknown' (#216)
218
                                $s = self::pcre('preg_replace', ['#[^\x00-\x7F]++#', '', $s]); // remove non-ascii chars
1✔
219
                        }
220
                } elseif ($iconv === 'glibc' || $iconv === 'libiconv') {
×
221
                        // temporarily hide these characters to distinguish them from the garbage that iconv creates
222
                        $s = strtr($s, '`\'"^~?', "\x01\x02\x03\x04\x05\x06");
×
223
                        if ($iconv === 'glibc') {
×
224
                                // glibc implementation is very limited. transliterate into Windows-1250 and then into ASCII, so most Eastern European characters are preserved
225
                                $s = iconv('UTF-8', 'WINDOWS-1250//TRANSLIT//IGNORE', $s);
×
226
                                $s = strtr(
×
227
                                        $s,
×
228
                                        "\xa5\xa3\xbc\x8c\xa7\x8a\xaa\x8d\x8f\x8e\xaf\xb9\xb3\xbe\x9c\x9a\xba\x9d\x9f\x9e\xbf\xc0\xc1\xc2\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xcc\xcd\xce\xcf\xd0\xd1\xd2\xd3\xd4\xd5\xd6\xd7\xd8\xd9\xda\xdb\xdc\xdd\xde\xdf\xe0\xe1\xe2\xe3\xe4\xe5\xe6\xe7\xe8\xe9\xea\xeb\xec\xed\xee\xef\xf0\xf1\xf2\xf3\xf4\xf5\xf6\xf8\xf9\xfa\xfb\xfc\xfd\xfe\x96\xa0\x8b\x97\x9b\xa6\xad\xb7",
×
229
                                        'ALLSSSSTZZZallssstzzzRAAAALCCCEEEEIIDDNNOOOOxRUUUUYTsraaaalccceeeeiiddnnooooruuuuyt- <->|-.',
×
230
                                );
231
                                $s = self::pcre('preg_replace', ['#[^\x00-\x7F]++#', '', $s]);
×
232
                        } else {
233
                                $s = iconv('UTF-8', 'ASCII//TRANSLIT//IGNORE', $s);
×
234
                        }
235

236
                        // remove garbage that iconv creates during transliteration (eg Ý -> Y')
237
                        $s = str_replace(['`', "'", '"', '^', '~', '?'], '', $s);
×
238
                        // restore temporarily hidden characters
239
                        $s = strtr($s, "\x01\x02\x03\x04\x05\x06", '`\'"^~?');
×
240
                } else {
241
                        $s = self::pcre('preg_replace', ['#[^\x00-\x7F]++#', '', $s]); // remove non-ascii chars
×
242
                }
243

244
                return $s;
1✔
245
        }
246

247

248
        /**
249
         * Modifies the UTF-8 string to the form used in the URL, ie removes diacritics and replaces all characters
250
         * except letters of the English alphabet and numbers with a hyphens.
251
         */
252
        public static function webalize(string $s, ?string $charlist = null, bool $lower = true): string
1✔
253
        {
254
                $s = self::toAscii($s);
1✔
255
                if ($lower) {
1✔
256
                        $s = strtolower($s);
1✔
257
                }
258

259
                $s = self::pcre('preg_replace', ['#[^a-z0-9' . ($charlist !== null ? preg_quote($charlist, '#') : '') . ']+#i', '-', $s]);
1✔
260
                $s = trim($s, '-');
1✔
261
                return $s;
1✔
262
        }
263

264

265
        /**
266
         * Truncates a UTF-8 string to given maximal length, while trying not to split whole words. Only if the string is truncated,
267
         * an ellipsis (or something else set with third argument) is appended to the string.
268
         */
269
        public static function truncate(string $s, int $maxLen, string $append = "\u{2026}"): string
1✔
270
        {
271
                if (self::length($s) > $maxLen) {
1✔
272
                        $maxLen -= self::length($append);
1✔
273
                        if ($maxLen < 1) {
1✔
274
                                return $append;
1✔
275

276
                        } elseif ($matches = self::match($s, '#^.{1,' . $maxLen . '}(?=[\s\x00-/:-@\[-`{-~])#us')) {
1✔
277
                                return $matches[0] . $append;
1✔
278

279
                        } else {
280
                                return self::substring($s, 0, $maxLen) . $append;
1✔
281
                        }
282
                }
283

284
                return $s;
1✔
285
        }
286

287

288
        /**
289
         * Indents a multiline text from the left. Second argument sets how many indentation chars should be used,
290
         * while the indent itself is the third argument (*tab* by default).
291
         */
292
        public static function indent(string $s, int $level = 1, string $chars = "\t"): string
1✔
293
        {
294
                if ($level > 0) {
1✔
295
                        $s = self::replace($s, '#(?:^|[\r\n]+)(?=[^\r\n])#', '$0' . str_repeat($chars, $level));
1✔
296
                }
297

298
                return $s;
1✔
299
        }
300

301

302
        /**
303
         * Converts all characters of UTF-8 string to lower case.
304
         */
305
        public static function lower(string $s): string
1✔
306
        {
307
                return mb_strtolower($s, 'UTF-8');
1✔
308
        }
309

310

311
        /**
312
         * Converts the first character of a UTF-8 string to lower case and leaves the other characters unchanged.
313
         */
314
        public static function firstLower(string $s): string
1✔
315
        {
316
                return self::lower(self::substring($s, 0, 1)) . self::substring($s, 1);
1✔
317
        }
318

319

320
        /**
321
         * Converts all characters of a UTF-8 string to upper case.
322
         */
323
        public static function upper(string $s): string
1✔
324
        {
325
                return mb_strtoupper($s, 'UTF-8');
1✔
326
        }
327

328

329
        /**
330
         * Converts the first character of a UTF-8 string to upper case and leaves the other characters unchanged.
331
         */
332
        public static function firstUpper(string $s): string
1✔
333
        {
334
                return self::upper(self::substring($s, 0, 1)) . self::substring($s, 1);
1✔
335
        }
336

337

338
        /**
339
         * Converts the first character of every word of a UTF-8 string to upper case and the others to lower case.
340
         */
341
        public static function capitalize(string $s): string
1✔
342
        {
343
                return mb_convert_case($s, MB_CASE_TITLE, 'UTF-8');
1✔
344
        }
345

346

347
        /**
348
         * Compares two UTF-8 strings or their parts, without taking character case into account. If length is null, whole strings are compared,
349
         * if it is negative, the corresponding number of characters from the end of the strings is compared,
350
         * otherwise the appropriate number of characters from the beginning is compared.
351
         */
352
        public static function compare(string $left, string $right, ?int $length = null): bool
1✔
353
        {
354
                if (class_exists('Normalizer', false)) {
1✔
355
                        $left = \Normalizer::normalize($left, \Normalizer::FORM_D); // form NFD is faster
1✔
356
                        $right = \Normalizer::normalize($right, \Normalizer::FORM_D); // form NFD is faster
1✔
357
                }
358

359
                if ($length < 0) {
1✔
360
                        $left = self::substring($left, $length, -$length);
1✔
361
                        $right = self::substring($right, $length, -$length);
1✔
362
                } elseif ($length !== null) {
1✔
363
                        $left = self::substring($left, 0, $length);
1✔
364
                        $right = self::substring($right, 0, $length);
1✔
365
                }
366

367
                return self::lower($left) === self::lower($right);
1✔
368
        }
369

370

371
        /**
372
         * Finds the common prefix of strings or returns empty string if the prefix was not found.
373
         * @param  string[]  $strings
374
         */
375
        public static function findPrefix(array $strings): string
1✔
376
        {
377
                $first = array_shift($strings);
1✔
378
                for ($i = 0; $i < strlen($first); $i++) {
1✔
379
                        foreach ($strings as $s) {
1✔
380
                                if (!isset($s[$i]) || $first[$i] !== $s[$i]) {
1✔
381
                                        while ($i && $first[$i - 1] >= "\x80" && $first[$i] >= "\x80" && $first[$i] < "\xC0") {
1✔
382
                                                $i--;
1✔
383
                                        }
384

385
                                        return substr($first, 0, $i);
1✔
386
                                }
387
                        }
388
                }
389

390
                return $first;
1✔
391
        }
392

393

394
        /**
395
         * Returns number of characters (not bytes) in UTF-8 string.
396
         * That is the number of Unicode code points which may differ from the number of graphemes.
397
         */
398
        public static function length(string $s): int
1✔
399
        {
400
                return match (true) {
401
                        extension_loaded('mbstring') => mb_strlen($s, 'UTF-8'),
1✔
402
                        extension_loaded('iconv') => iconv_strlen($s, 'UTF-8'),
×
403
                        default => strlen(@utf8_decode($s)), // deprecated
1✔
404
                };
405
        }
406

407

408
        /**
409
         * Removes all left and right side spaces (or the characters passed as second argument) from a UTF-8 encoded string.
410
         */
411
        public static function trim(string $s, string $charlist = self::TrimCharacters): string
1✔
412
        {
413
                $charlist = preg_quote($charlist, '#');
1✔
414
                return self::replace($s, '#^[' . $charlist . ']+|[' . $charlist . ']+$#Du', '');
1✔
415
        }
416

417

418
        /**
419
         * Pads a UTF-8 string to given length by prepending the $pad string to the beginning.
420
         * @param  non-empty-string  $pad
421
         */
422
        public static function padLeft(string $s, int $length, string $pad = ' '): string
1✔
423
        {
424
                $length = max(0, $length - self::length($s));
1✔
425
                $padLen = self::length($pad);
1✔
426
                return str_repeat($pad, (int) ($length / $padLen)) . self::substring($pad, 0, $length % $padLen) . $s;
1✔
427
        }
428

429

430
        /**
431
         * Pads UTF-8 string to given length by appending the $pad string to the end.
432
         * @param  non-empty-string  $pad
433
         */
434
        public static function padRight(string $s, int $length, string $pad = ' '): string
1✔
435
        {
436
                $length = max(0, $length - self::length($s));
1✔
437
                $padLen = self::length($pad);
1✔
438
                return $s . str_repeat($pad, (int) ($length / $padLen)) . self::substring($pad, 0, $length % $padLen);
1✔
439
        }
440

441

442
        /**
443
         * Reverses UTF-8 string.
444
         */
445
        public static function reverse(string $s): string
1✔
446
        {
447
                if (!extension_loaded('iconv')) {
1✔
448
                        throw new Nette\NotSupportedException(__METHOD__ . '() requires ICONV extension that is not loaded.');
×
449
                }
450

451
                return iconv('UTF-32LE', 'UTF-8', strrev(iconv('UTF-8', 'UTF-32BE', $s)));
1✔
452
        }
453

454

455
        /**
456
         * Returns part of $haystack before $nth occurence of $needle or returns null if the needle was not found.
457
         * Negative value means searching from the end.
458
         */
459
        public static function before(string $haystack, string $needle, int $nth = 1): ?string
1✔
460
        {
461
                $pos = self::pos($haystack, $needle, $nth);
1✔
462
                return $pos === null
1✔
463
                        ? null
1✔
464
                        : substr($haystack, 0, $pos);
1✔
465
        }
466

467

468
        /**
469
         * Returns part of $haystack after $nth occurence of $needle or returns null if the needle was not found.
470
         * Negative value means searching from the end.
471
         */
472
        public static function after(string $haystack, string $needle, int $nth = 1): ?string
1✔
473
        {
474
                $pos = self::pos($haystack, $needle, $nth);
1✔
475
                return $pos === null
1✔
476
                        ? null
1✔
477
                        : substr($haystack, $pos + strlen($needle));
1✔
478
        }
479

480

481
        /**
482
         * Returns position in characters of $nth occurence of $needle in $haystack or null if the $needle was not found.
483
         * Negative value of `$nth` means searching from the end.
484
         */
485
        public static function indexOf(string $haystack, string $needle, int $nth = 1): ?int
1✔
486
        {
487
                $pos = self::pos($haystack, $needle, $nth);
1✔
488
                return $pos === null
1✔
489
                        ? null
1✔
490
                        : self::length(substr($haystack, 0, $pos));
1✔
491
        }
492

493

494
        /**
495
         * Returns position in characters of $nth occurence of $needle in $haystack or null if the needle was not found.
496
         */
497
        private static function pos(string $haystack, string $needle, int $nth = 1): ?int
1✔
498
        {
499
                if (!$nth) {
1✔
500
                        return null;
1✔
501
                } elseif ($nth > 0) {
1✔
502
                        if ($needle === '') {
1✔
503
                                return 0;
1✔
504
                        }
505

506
                        $pos = 0;
1✔
507
                        while (($pos = strpos($haystack, $needle, $pos)) !== false && --$nth) {
1✔
508
                                $pos++;
1✔
509
                        }
510
                } else {
511
                        $len = strlen($haystack);
1✔
512
                        if ($needle === '') {
1✔
513
                                return $len;
1✔
514
                        } elseif ($len === 0) {
1✔
515
                                return null;
1✔
516
                        }
517

518
                        $pos = $len - 1;
1✔
519
                        while (($pos = strrpos($haystack, $needle, $pos - $len)) !== false && ++$nth) {
1✔
520
                                $pos--;
1✔
521
                        }
522
                }
523

524
                return Helpers::falseToNull($pos);
1✔
525
        }
526

527

528
        /**
529
         * Divides the string into arrays according to the regular expression. Expressions in parentheses will be captured and returned as well.
530
         */
531
        public static function split(
1✔
532
                string $subject,
533
                #[Language('RegExp')]
534
                string $pattern,
535
                bool|int $captureOffset = false,
536
                bool $skipEmpty = false,
537
                int $limit = -1,
538
                bool $utf8 = false,
539
        ): array
540
        {
541
                $flags = is_int($captureOffset)  // back compatibility
1✔
542
                        ? $captureOffset
1✔
543
                        : ($captureOffset ? PREG_SPLIT_OFFSET_CAPTURE : 0) | ($skipEmpty ? PREG_SPLIT_NO_EMPTY : 0);
1✔
544

545
                $pattern .= $utf8 ? 'u' : '';
1✔
546
                $m = self::pcre('preg_split', [$pattern, $subject, $limit, $flags | PREG_SPLIT_DELIM_CAPTURE]);
1✔
547
                return $utf8 && $captureOffset
1✔
548
                        ? self::bytesToChars($subject, [$m])[0]
1✔
549
                        : $m;
1✔
550
        }
551

552

553
        /**
554
         * Searches the string for the part matching the regular expression and returns
555
         * an array with the found expression and individual subexpressions, or `null`.
556
         */
557
        public static function match(
1✔
558
                string $subject,
559
                #[Language('RegExp')]
560
                string $pattern,
561
                bool|int $captureOffset = false,
562
                int $offset = 0,
563
                bool $unmatchedAsNull = false,
564
                bool $utf8 = false,
565
        ): ?array
566
        {
567
                $flags = is_int($captureOffset) // back compatibility
1✔
568
                        ? $captureOffset
1✔
569
                        : ($captureOffset ? PREG_OFFSET_CAPTURE : 0) | ($unmatchedAsNull ? PREG_UNMATCHED_AS_NULL : 0);
1✔
570

571
                if ($utf8) {
1✔
572
                        $offset = strlen(self::substring($subject, 0, $offset));
1✔
573
                        $pattern .= 'u';
1✔
574
                }
575

576
                if ($offset > strlen($subject)) {
1✔
577
                        return null;
1✔
578
                } elseif (!self::pcre('preg_match', [$pattern, $subject, &$m, $flags, $offset])) {
1✔
579
                        return null;
1✔
580
                } elseif ($utf8 && $captureOffset) {
1✔
581
                        return self::bytesToChars($subject, [$m])[0];
1✔
582
                } else {
583
                        return $m;
1✔
584
                }
585
        }
586

587

588
        /**
589
         * Searches the string for all occurrences matching the regular expression and
590
         * returns an array of arrays containing the found expression and each subexpression.
591
         * @return ($lazy is true ? \Generator<int, array> : array[])
592
         */
593
        public static function matchAll(
1✔
594
                string $subject,
595
                #[Language('RegExp')]
596
                string $pattern,
597
                bool|int $captureOffset = false,
598
                int $offset = 0,
599
                bool $unmatchedAsNull = false,
600
                bool $patternOrder = false,
601
                bool $utf8 = false,
602
                bool $lazy = false,
603
        ): array|\Generator
604
        {
605
                if ($utf8) {
1✔
606
                        $offset = strlen(self::substring($subject, 0, $offset));
1✔
607
                        $pattern .= 'u';
1✔
608
                }
609

610
                if ($lazy) {
1✔
611
                        $flags = PREG_OFFSET_CAPTURE | ($unmatchedAsNull ? PREG_UNMATCHED_AS_NULL : 0);
1✔
612
                        return (function () use ($utf8, $captureOffset, $flags, $subject, $pattern, $offset) {
1✔
613
                                $counter = 0;
1✔
614
                                while (
615
                                        $offset <= strlen($subject) - ($counter ? 1 : 0)
1✔
616
                                        && self::pcre('preg_match', [$pattern, $subject, &$m, $flags, $offset])
1✔
617
                                ) {
618
                                        $offset = $m[0][1] + max(1, strlen($m[0][0]));
1✔
619
                                        if (!$captureOffset) {
1✔
620
                                                $m = array_map(fn($item) => $item[0], $m);
1✔
621
                                        } elseif ($utf8) {
1✔
622
                                                $m = self::bytesToChars($subject, [$m])[0];
1✔
623
                                        }
624
                                        yield $counter++ => $m;
1✔
625
                                }
626
                        })();
1✔
627
                }
628

629
                if ($offset > strlen($subject)) {
1✔
630
                        return [];
1✔
631
                }
632

633
                $flags = is_int($captureOffset) // back compatibility
1✔
634
                        ? $captureOffset
1✔
635
                        : ($captureOffset ? PREG_OFFSET_CAPTURE : 0) | ($unmatchedAsNull ? PREG_UNMATCHED_AS_NULL : 0) | ($patternOrder ? PREG_PATTERN_ORDER : 0);
1✔
636

637
                self::pcre('preg_match_all', [
1✔
638
                        $pattern, $subject, &$m,
1✔
639
                        ($flags & PREG_PATTERN_ORDER) ? $flags : ($flags | PREG_SET_ORDER),
1✔
640
                        $offset,
1✔
641
                ]);
642
                return $utf8 && $captureOffset
1✔
643
                        ? self::bytesToChars($subject, $m)
1✔
644
                        : $m;
1✔
645
        }
646

647

648
        /**
649
         * Replaces all occurrences matching regular expression $pattern which can be string or array in the form `pattern => replacement`.
650
         */
651
        public static function replace(
1✔
652
                string $subject,
653
                #[Language('RegExp')]
654
                string|array $pattern,
655
                string|callable $replacement = '',
656
                int $limit = -1,
657
                bool $captureOffset = false,
658
                bool $unmatchedAsNull = false,
659
                bool $utf8 = false,
660
        ): string
661
        {
662
                if (is_object($replacement) || is_array($replacement)) {
1✔
663
                        if (!is_callable($replacement, false, $textual)) {
1✔
664
                                throw new Nette\InvalidStateException("Callback '$textual' is not callable.");
×
665
                        }
666

667
                        $flags = ($captureOffset ? PREG_OFFSET_CAPTURE : 0) | ($unmatchedAsNull ? PREG_UNMATCHED_AS_NULL : 0);
1✔
668
                        if ($utf8) {
1✔
669
                                $pattern .= 'u';
1✔
670
                                if ($captureOffset) {
1✔
671
                                        $replacement = fn($m) => $replacement(self::bytesToChars($subject, [$m])[0]);
1✔
672
                                }
673
                        }
674

675
                        return self::pcre('preg_replace_callback', [$pattern, $replacement, $subject, $limit, 0, $flags]);
1✔
676

677
                } elseif (is_array($pattern) && is_string(key($pattern))) {
1✔
678
                        $replacement = array_values($pattern);
1✔
679
                        $pattern = array_keys($pattern);
1✔
680
                }
681

682
                if ($utf8) {
1✔
683
                        $pattern = array_map(fn($item) => $item . 'u', (array) $pattern);
1✔
684
                }
685

686
                return self::pcre('preg_replace', [$pattern, $replacement, $subject, $limit]);
1✔
687
        }
688

689

690
        private static function bytesToChars(string $s, array $groups): array
1✔
691
        {
692
                $lastBytes = $lastChars = 0;
1✔
693
                foreach ($groups as &$matches) {
1✔
694
                        foreach ($matches as &$match) {
1✔
695
                                if ($match[1] > $lastBytes) {
1✔
696
                                        $lastChars += self::length(substr($s, $lastBytes, $match[1] - $lastBytes));
1✔
697
                                } elseif ($match[1] < $lastBytes) {
1✔
698
                                        $lastChars -= self::length(substr($s, $match[1], $lastBytes - $match[1]));
1✔
699
                                }
700

701
                                $lastBytes = $match[1];
1✔
702
                                $match[1] = $lastChars;
1✔
703
                        }
704
                }
705

706
                return $groups;
1✔
707
        }
708

709

710
        /** @internal */
711
        public static function pcre(string $func, array $args)
1✔
712
        {
713
                $res = Callback::invokeSafe($func, $args, function (string $message) use ($args): void {
1✔
714
                        // compile-time error, not detectable by preg_last_error
715
                        throw new RegexpException($message . ' in pattern: ' . implode(' or ', (array) $args[0]));
1✔
716
                });
1✔
717

718
                if (($code = preg_last_error()) // run-time error, but preg_last_error & return code are liars
1✔
719
                        && ($res === null || !in_array($func, ['preg_filter', 'preg_replace_callback', 'preg_replace'], true))
1✔
720
                ) {
721
                        throw new RegexpException(preg_last_error_msg()
1✔
722
                                . ' (pattern: ' . implode(' or ', (array) $args[0]) . ')', $code);
1✔
723
                }
724

725
                return $res;
1✔
726
        }
727
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc