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

nette / utils / 21972698538

13 Feb 2026 02:47AM UTC coverage: 93.125% (-0.07%) from 93.199%
21972698538

push

github

dg
added CLAUDE.md

2086 of 2240 relevant lines covered (93.13%)

0.93 hits per line

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

91.45
/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 array_keys, array_map, array_shift, array_values, bin2hex, class_exists, defined, extension_loaded, function_exists, htmlspecialchars, htmlspecialchars_decode, iconv, iconv_strlen, iconv_substr, implode, in_array, is_array, is_callable, is_int, is_object, is_string, key, max, mb_convert_case, mb_strlen, mb_strtolower, mb_strtoupper, mb_substr, pack, preg_last_error, preg_last_error_msg, preg_quote, preg_replace, str_contains, str_ends_with, str_repeat, str_replace, str_starts_with, strlen, strpos, strrev, strrpos, strtolower, strtoupper, strtr, substr, trim, unpack, utf8_decode;
15
use const ENT_IGNORE, ENT_NOQUOTES, ICONV_IMPL, MB_CASE_TITLE, PHP_EOL, PREG_OFFSET_CAPTURE, PREG_PATTERN_ORDER, PREG_SET_ORDER, PREG_SPLIT_DELIM_CAPTURE, PREG_SPLIT_NO_EMPTY, PREG_SPLIT_OFFSET_CAPTURE, PREG_UNMATCHED_AS_NULL;
16

17

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

25
        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}\u{2028}\u{3000}";
26

27
        #[\Deprecated('use Strings::TrimCharacters')]
28
        public const TRIM_CHARACTERS = self::TrimCharacters;
29

30

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

39

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

49

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

62
                $res = iconv('UTF-32BE', 'UTF-8//IGNORE', pack('N', $code));
1✔
63
                return $res === false ? throw new Nette\ShouldNotHappenException : $res;
1✔
64
        }
65

66

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

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

81
                return unpack('N', $tmp)[1] ?? throw new Nette\ShouldNotHappenException;
1✔
82
        }
83

84

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

93

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

102

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

111

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

128
                $res = iconv_substr($s, $start, $length, 'UTF-8');
×
129
                return $res === false ? throw new Nette\InvalidStateException('iconv_substr() failed.') : $res;
×
130
        }
131

132

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

144
                $s = self::unixNewLines($s);
1✔
145

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

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

152
                // leading and trailing blank lines
153
                $s = trim($s, "\n");
1✔
154

155
                return $s;
1✔
156
        }
157

158

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

165

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

175

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

185

186
        /**
187
         * Converts UTF-8 string to ASCII, ie removes diacritics etc.
188
         */
189
        public static function toAscii(string $s): string
1✔
190
        {
191
                if (!extension_loaded('intl')) {
1✔
192
                        throw new Nette\NotSupportedException(__METHOD__ . '() requires INTL extension that is not loaded.');
×
193
                }
194

195
                $iconv = defined('ICONV_IMPL') ? trim(ICONV_IMPL, '"\'') : null;
1✔
196

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

200
                // transliteration (by Transliterator and iconv) is not optimal, replace some characters directly
201
                $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✔
202
                if ($iconv !== 'libiconv') {
1✔
203
                        $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✔
204
                }
205

206
                $s = \Transliterator::create('Any-Latin; Latin-ASCII')?->transliterate($s)
1✔
207
                        ?? throw new Nette\InvalidStateException('Transliterator::transliterate() failed.');
×
208

209
                // use iconv because The transliterator leaves some characters out of ASCII, eg → ʾ
210
                if ($iconv === 'glibc') {
1✔
211
                        $s = strtr($s, '?', "\x01"); // temporarily hide ? to distinguish them from the garbage that iconv creates
1✔
212
                        $s = iconv('UTF-8', 'ASCII//TRANSLIT//IGNORE', $s);
1✔
213
                        if ($s === false) {
1✔
214
                                throw new Nette\InvalidStateException('iconv() failed.');
×
215
                        }
216

217
                        $s = str_replace(['?', "\x01"], ['', '?'], $s); // remove garbage and restore ? characters
1✔
218
                } elseif ($iconv === 'libiconv') {
×
219
                        $s = iconv('UTF-8', 'ASCII//TRANSLIT//IGNORE', $s);
×
220
                        if ($s === false) {
×
221
                                throw new Nette\InvalidStateException('iconv() failed.');
×
222
                        }
223
                } else { // null or 'unknown' (#216)
224
                        $s = self::pcre('preg_replace', ['#[^\x00-\x7F]++#', '', $s]); // remove non-ascii chars
×
225
                }
226

227
                return $s;
1✔
228
        }
229

230

231
        /**
232
         * Modifies the UTF-8 string to the form used in the URL, ie removes diacritics and replaces all characters
233
         * except letters of the English alphabet and numbers with a hyphens.
234
         */
235
        public static function webalize(string $s, ?string $charlist = null, bool $lower = true): string
1✔
236
        {
237
                $s = self::toAscii($s);
1✔
238
                if ($lower) {
1✔
239
                        $s = strtolower($s);
1✔
240
                }
241

242
                $s = self::pcre('preg_replace', ['#[^a-z0-9' . ($charlist !== null ? preg_quote($charlist, '#') : '') . ']+#i', '-', $s]);
1✔
243
                $s = trim($s, '-');
1✔
244
                return $s;
1✔
245
        }
246

247

248
        /**
249
         * Truncates a UTF-8 string to given maximal length, while trying not to split whole words. Only if the string is truncated,
250
         * an ellipsis (or something else set with third argument) is appended to the string.
251
         */
252
        public static function truncate(string $s, int $maxLen, string $append = "\u{2026}"): string
1✔
253
        {
254
                if (self::length($s) > $maxLen) {
1✔
255
                        $maxLen -= self::length($append);
1✔
256
                        if ($maxLen < 1) {
1✔
257
                                return $append;
1✔
258

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

262
                        } else {
263
                                return self::substring($s, 0, $maxLen) . $append;
1✔
264
                        }
265
                }
266

267
                return $s;
1✔
268
        }
269

270

271
        /**
272
         * Indents a multiline text from the left. Second argument sets how many indentation chars should be used,
273
         * while the indent itself is the third argument (*tab* by default).
274
         */
275
        public static function indent(string $s, int $level = 1, string $chars = "\t"): string
1✔
276
        {
277
                if ($level > 0) {
1✔
278
                        $s = self::replace($s, '#(?:^|[\r\n]+)(?=[^\r\n])#', '$0' . str_repeat($chars, $level));
1✔
279
                }
280

281
                return $s;
1✔
282
        }
283

284

285
        /**
286
         * Converts all characters of UTF-8 string to lower case.
287
         */
288
        public static function lower(string $s): string
1✔
289
        {
290
                return mb_strtolower($s, 'UTF-8');
1✔
291
        }
292

293

294
        /**
295
         * Converts the first character of a UTF-8 string to lower case and leaves the other characters unchanged.
296
         */
297
        public static function firstLower(string $s): string
1✔
298
        {
299
                return self::lower(self::substring($s, 0, 1)) . self::substring($s, 1);
1✔
300
        }
301

302

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

311

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

320

321
        /**
322
         * Converts the first character of every word of a UTF-8 string to upper case and the others to lower case.
323
         */
324
        public static function capitalize(string $s): string
1✔
325
        {
326
                return mb_convert_case($s, MB_CASE_TITLE, 'UTF-8');
1✔
327
        }
328

329

330
        /**
331
         * Compares two UTF-8 strings or their parts, without taking character case into account. If length is null, whole strings are compared,
332
         * if it is negative, the corresponding number of characters from the end of the strings is compared,
333
         * otherwise the appropriate number of characters from the beginning is compared.
334
         */
335
        public static function compare(string $left, string $right, ?int $length = null): bool
1✔
336
        {
337
                if (class_exists('Normalizer', autoload: false)) {
1✔
338
                        $left = \Normalizer::normalize($left, \Normalizer::FORM_D); // form NFD is faster
1✔
339
                        $right = \Normalizer::normalize($right, \Normalizer::FORM_D); // form NFD is faster
1✔
340
                }
341

342
                if ($length < 0) {
1✔
343
                        $left = self::substring($left, $length, -$length);
1✔
344
                        $right = self::substring($right, $length, -$length);
1✔
345
                } elseif ($length !== null) {
1✔
346
                        $left = self::substring($left, 0, $length);
1✔
347
                        $right = self::substring($right, 0, $length);
1✔
348
                }
349

350
                return self::lower($left) === self::lower($right);
1✔
351
        }
352

353

354
        /**
355
         * Finds the common prefix of strings or returns empty string if the prefix was not found.
356
         * @param  string[]  $strings
357
         */
358
        public static function findPrefix(array $strings): string
1✔
359
        {
360
                $first = array_shift($strings);
1✔
361
                if ($first === null) {
1✔
362
                        return '';
×
363
                }
364

365
                for ($i = 0; $i < strlen($first); $i++) {
1✔
366
                        foreach ($strings as $s) {
1✔
367
                                if (!isset($s[$i]) || $first[$i] !== $s[$i]) {
1✔
368
                                        while ($i && $first[$i - 1] >= "\x80" && $first[$i] >= "\x80" && $first[$i] < "\xC0") {
1✔
369
                                                $i--;
1✔
370
                                        }
371

372
                                        return substr($first, 0, $i);
1✔
373
                                }
374
                        }
375
                }
376

377
                return $first;
1✔
378
        }
379

380

381
        /**
382
         * Returns number of characters (not bytes) in UTF-8 string.
383
         * That is the number of Unicode code points which may differ from the number of graphemes.
384
         */
385
        public static function length(string $s): int
1✔
386
        {
387
                return match (true) {
388
                        extension_loaded('mbstring') => (int) mb_strlen($s, 'UTF-8'),
1✔
389
                        extension_loaded('iconv') => (int) iconv_strlen($s, 'UTF-8'),
×
390
                        default => strlen(@utf8_decode($s)), // deprecated
1✔
391
                };
392
        }
393

394

395
        /**
396
         * Removes all left and right side spaces (or the characters passed as second argument) from a UTF-8 encoded string.
397
         */
398
        public static function trim(string $s, string $charlist = self::TrimCharacters): string
1✔
399
        {
400
                $charlist = preg_quote($charlist, '#');
1✔
401
                return self::replace($s, '#^[' . $charlist . ']+|[' . $charlist . ']+$#Du', '');
1✔
402
        }
403

404

405
        /**
406
         * Pads a UTF-8 string to given length by prepending the $pad string to the beginning.
407
         * @param  non-empty-string  $pad
408
         */
409
        public static function padLeft(string $s, int $length, string $pad = ' '): string
1✔
410
        {
411
                $length = max(0, $length - self::length($s));
1✔
412
                $padLen = self::length($pad);
1✔
413
                return str_repeat($pad, (int) ($length / $padLen)) . self::substring($pad, 0, $length % $padLen) . $s;
1✔
414
        }
415

416

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

428

429
        /**
430
         * Reverses UTF-8 string.
431
         */
432
        public static function reverse(string $s): string
1✔
433
        {
434
                if (!extension_loaded('iconv')) {
1✔
435
                        throw new Nette\NotSupportedException(__METHOD__ . '() requires ICONV extension that is not loaded.');
×
436
                }
437

438
                $tmp = iconv('UTF-8', 'UTF-32BE', $s);
1✔
439
                return $tmp === false
1✔
440
                        ? throw new Nette\InvalidStateException('iconv() failed.')
×
441
                        : (string) iconv('UTF-32LE', 'UTF-8', strrev($tmp));
1✔
442
        }
443

444

445
        /**
446
         * Returns part of $haystack before $nth occurence of $needle or returns null if the needle was not found.
447
         * Negative value means searching from the end.
448
         */
449
        public static function before(string $haystack, string $needle, int $nth = 1): ?string
1✔
450
        {
451
                $pos = self::pos($haystack, $needle, $nth);
1✔
452
                return $pos === null
1✔
453
                        ? null
1✔
454
                        : substr($haystack, 0, $pos);
1✔
455
        }
456

457

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

470

471
        /**
472
         * Returns position in characters of $nth occurence of $needle in $haystack or null if the $needle was not found.
473
         * Negative value of `$nth` means searching from the end.
474
         */
475
        public static function indexOf(string $haystack, string $needle, int $nth = 1): ?int
1✔
476
        {
477
                $pos = self::pos($haystack, $needle, $nth);
1✔
478
                return $pos === null
1✔
479
                        ? null
1✔
480
                        : self::length(substr($haystack, 0, $pos));
1✔
481
        }
482

483

484
        /**
485
         * Returns position in characters of $nth occurence of $needle in $haystack or null if the needle was not found.
486
         */
487
        private static function pos(string $haystack, string $needle, int $nth = 1): ?int
1✔
488
        {
489
                if (!$nth) {
1✔
490
                        return null;
1✔
491
                } elseif ($nth > 0) {
1✔
492
                        if ($needle === '') {
1✔
493
                                return 0;
1✔
494
                        }
495

496
                        $pos = 0;
1✔
497
                        while (($pos = strpos($haystack, $needle, $pos)) !== false && --$nth) {
1✔
498
                                $pos++;
1✔
499
                        }
500
                } else {
501
                        $len = strlen($haystack);
1✔
502
                        if ($needle === '') {
1✔
503
                                return $len;
1✔
504
                        } elseif ($len === 0) {
1✔
505
                                return null;
1✔
506
                        }
507

508
                        $pos = $len - 1;
1✔
509
                        while (($pos = strrpos($haystack, $needle, $pos - $len)) !== false && ++$nth) {
1✔
510
                                $pos--;
1✔
511
                        }
512
                }
513

514
                return Helpers::falseToNull($pos);
1✔
515
        }
516

517

518
        /**
519
         * Divides the string into arrays according to the regular expression. Expressions in parentheses will be captured and returned as well.
520
         * @return list<string>
521
         */
522
        public static function split(
1✔
523
                string $subject,
524
                #[Language('RegExp')]
525
                string $pattern,
526
                bool|int $captureOffset = false,
527
                bool $skipEmpty = false,
528
                int $limit = -1,
529
                bool $utf8 = false,
530
        ): array
531
        {
532
                $flags = is_int($captureOffset)  // back compatibility
1✔
533
                        ? $captureOffset
1✔
534
                        : ($captureOffset ? PREG_SPLIT_OFFSET_CAPTURE : 0) | ($skipEmpty ? PREG_SPLIT_NO_EMPTY : 0);
1✔
535

536
                $pattern .= $utf8 ? 'u' : '';
1✔
537
                $m = self::pcre('preg_split', [$pattern, $subject, $limit, $flags | PREG_SPLIT_DELIM_CAPTURE]);
1✔
538
                return $utf8 && $captureOffset
1✔
539
                        ? self::bytesToChars($subject, [$m])[0]
1✔
540
                        : $m;
1✔
541
        }
542

543

544
        /**
545
         * Searches the string for the part matching the regular expression and returns
546
         * an array with the found expression and individual subexpressions, or `null`.
547
         * @return ?array<string>
548
         */
549
        public static function match(
1✔
550
                string $subject,
551
                #[Language('RegExp')]
552
                string $pattern,
553
                bool|int $captureOffset = false,
554
                int $offset = 0,
555
                bool $unmatchedAsNull = false,
556
                bool $utf8 = false,
557
        ): ?array
558
        {
559
                $flags = is_int($captureOffset) // back compatibility
1✔
560
                        ? $captureOffset
1✔
561
                        : ($captureOffset ? PREG_OFFSET_CAPTURE : 0) | ($unmatchedAsNull ? PREG_UNMATCHED_AS_NULL : 0);
1✔
562

563
                if ($utf8) {
1✔
564
                        $offset = strlen(self::substring($subject, 0, $offset));
1✔
565
                        $pattern .= 'u';
1✔
566
                }
567

568
                $m = [];
1✔
569
                if ($offset > strlen($subject)) {
1✔
570
                        return null;
1✔
571
                } elseif (!self::pcre('preg_match', [$pattern, $subject, &$m, $flags, $offset])) {
1✔
572
                        return null;
1✔
573
                } elseif ($utf8 && $captureOffset) {
1✔
574
                        return self::bytesToChars($subject, [$m])[0];
1✔
575
                } else {
576
                        return $m;
1✔
577
                }
578
        }
579

580

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

603
                if ($lazy) {
1✔
604
                        $flags = PREG_OFFSET_CAPTURE | ($unmatchedAsNull ? PREG_UNMATCHED_AS_NULL : 0);
1✔
605
                        return (function () use ($utf8, $captureOffset, $flags, $subject, $pattern, $offset) {
1✔
606
                                $counter = 0;
1✔
607
                                $m = [];
1✔
608
                                while (
609
                                        $offset <= strlen($subject) - ($counter ? 1 : 0)
1✔
610
                                        && self::pcre('preg_match', [$pattern, $subject, &$m, $flags, $offset])
1✔
611
                                ) {
612
                                        /** @var list<array{string, int}> $m */
613
                                        $offset = $m[0][1] + max(1, strlen($m[0][0]));
1✔
614
                                        if (!$captureOffset) {
1✔
615
                                                $m = array_map(fn($item) => $item[0], $m);
1✔
616
                                        } elseif ($utf8) {
1✔
617
                                                $m = self::bytesToChars($subject, [$m])[0];
1✔
618
                                        }
619
                                        yield $counter++ => $m;
1✔
620
                                }
621
                        })();
1✔
622
                }
623

624
                if ($offset > strlen($subject)) {
1✔
625
                        return [];
1✔
626
                }
627

628
                $flags = is_int($captureOffset) // back compatibility
1✔
629
                        ? $captureOffset
1✔
630
                        : ($captureOffset ? PREG_OFFSET_CAPTURE : 0) | ($unmatchedAsNull ? PREG_UNMATCHED_AS_NULL : 0) | ($patternOrder ? PREG_PATTERN_ORDER : 0);
1✔
631

632
                $m = [];
1✔
633
                self::pcre('preg_match_all', [
1✔
634
                        $pattern, $subject, &$m,
1✔
635
                        ($flags & PREG_PATTERN_ORDER) ? $flags : ($flags | PREG_SET_ORDER),
1✔
636
                        $offset,
1✔
637
                ]);
638
                return $utf8 && $captureOffset
1✔
639
                        ? self::bytesToChars($subject, $m)
1✔
640
                        : $m;
1✔
641
        }
642

643

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

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

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

674
                } elseif (is_array($pattern) && is_string(key($pattern))) {
1✔
675
                        $replacement = array_values($pattern);
1✔
676
                        $pattern = array_keys($pattern);
1✔
677
                }
678

679
                if ($utf8) {
1✔
680
                        $pattern = array_map(fn($item) => $item . 'u', (array) $pattern);
1✔
681
                }
682

683
                return self::pcre('preg_replace', [$pattern, $replacement, $subject, $limit]);
1✔
684
        }
685

686

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

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

707
                return $groups;
1✔
708
        }
709

710

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

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

730
                return $res;
1✔
731
        }
732
}
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