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

nette / utils / 20431395313

22 Dec 2025 12:06PM UTC coverage: 93.164% (+71.8%) from 21.324%
20431395313

push

github

dg
Html::addText() accepts int|null for back compatibility [Closes #332][Closes #333]

1 of 1 new or added line in 1 file covered. (100.0%)

140 existing lines in 15 files now uncovered.

2058 of 2209 relevant lines covered (93.16%)

0.93 hits per line

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

93.7
/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✔
UNCOV
59
                        throw new Nette\NotSupportedException(__METHOD__ . '() requires ICONV extension that is not loaded.');
×
60
                }
61

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

65

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

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

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

83

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

92

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

101

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

110

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

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

130

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

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

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

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

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

153
                return $s;
1✔
154
        }
155

156

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

163

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

173

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

183

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

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

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

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

204
                $s = \Transliterator::create('Any-Latin; Latin-ASCII')->transliterate($s);
1✔
205
                // use iconv because The transliterator leaves some characters out of ASCII, eg → ʾ
206
                if ($iconv === 'glibc') {
1✔
207
                        $s = strtr($s, '?', "\x01"); // temporarily hide ? to distinguish them from the garbage that iconv creates
1✔
208
                        $s = iconv('UTF-8', 'ASCII//TRANSLIT//IGNORE', $s);
1✔
209
                        $s = str_replace(['?', "\x01"], ['', '?'], $s); // remove garbage and restore ? characters
1✔
UNCOV
210
                } elseif ($iconv === 'libiconv') {
×
UNCOV
211
                        $s = iconv('UTF-8', 'ASCII//TRANSLIT//IGNORE', $s);
×
212
                } else { // null or 'unknown' (#216)
UNCOV
213
                        $s = self::pcre('preg_replace', ['#[^\x00-\x7F]++#', '', $s]); // remove non-ascii chars
×
214
                }
215

216
                return $s;
1✔
217
        }
218

219

220
        /**
221
         * Modifies the UTF-8 string to the form used in the URL, ie removes diacritics and replaces all characters
222
         * except letters of the English alphabet and numbers with a hyphens.
223
         */
224
        public static function webalize(string $s, ?string $charlist = null, bool $lower = true): string
1✔
225
        {
226
                $s = self::toAscii($s);
1✔
227
                if ($lower) {
1✔
228
                        $s = strtolower($s);
1✔
229
                }
230

231
                $s = self::pcre('preg_replace', ['#[^a-z0-9' . ($charlist !== null ? preg_quote($charlist, '#') : '') . ']+#i', '-', $s]);
1✔
232
                $s = trim($s, '-');
1✔
233
                return $s;
1✔
234
        }
235

236

237
        /**
238
         * Truncates a UTF-8 string to given maximal length, while trying not to split whole words. Only if the string is truncated,
239
         * an ellipsis (or something else set with third argument) is appended to the string.
240
         */
241
        public static function truncate(string $s, int $maxLen, string $append = "\u{2026}"): string
1✔
242
        {
243
                if (self::length($s) > $maxLen) {
1✔
244
                        $maxLen -= self::length($append);
1✔
245
                        if ($maxLen < 1) {
1✔
246
                                return $append;
1✔
247

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

251
                        } else {
252
                                return self::substring($s, 0, $maxLen) . $append;
1✔
253
                        }
254
                }
255

256
                return $s;
1✔
257
        }
258

259

260
        /**
261
         * Indents a multiline text from the left. Second argument sets how many indentation chars should be used,
262
         * while the indent itself is the third argument (*tab* by default).
263
         */
264
        public static function indent(string $s, int $level = 1, string $chars = "\t"): string
1✔
265
        {
266
                if ($level > 0) {
1✔
267
                        $s = self::replace($s, '#(?:^|[\r\n]+)(?=[^\r\n])#', '$0' . str_repeat($chars, $level));
1✔
268
                }
269

270
                return $s;
1✔
271
        }
272

273

274
        /**
275
         * Converts all characters of UTF-8 string to lower case.
276
         */
277
        public static function lower(string $s): string
1✔
278
        {
279
                return mb_strtolower($s, 'UTF-8');
1✔
280
        }
281

282

283
        /**
284
         * Converts the first character of a UTF-8 string to lower case and leaves the other characters unchanged.
285
         */
286
        public static function firstLower(string $s): string
1✔
287
        {
288
                return self::lower(self::substring($s, 0, 1)) . self::substring($s, 1);
1✔
289
        }
290

291

292
        /**
293
         * Converts all characters of a UTF-8 string to upper case.
294
         */
295
        public static function upper(string $s): string
1✔
296
        {
297
                return mb_strtoupper($s, 'UTF-8');
1✔
298
        }
299

300

301
        /**
302
         * Converts the first character of a UTF-8 string to upper case and leaves the other characters unchanged.
303
         */
304
        public static function firstUpper(string $s): string
1✔
305
        {
306
                return self::upper(self::substring($s, 0, 1)) . self::substring($s, 1);
1✔
307
        }
308

309

310
        /**
311
         * Converts the first character of every word of a UTF-8 string to upper case and the others to lower case.
312
         */
313
        public static function capitalize(string $s): string
1✔
314
        {
315
                return mb_convert_case($s, MB_CASE_TITLE, 'UTF-8');
1✔
316
        }
317

318

319
        /**
320
         * Compares two UTF-8 strings or their parts, without taking character case into account. If length is null, whole strings are compared,
321
         * if it is negative, the corresponding number of characters from the end of the strings is compared,
322
         * otherwise the appropriate number of characters from the beginning is compared.
323
         */
324
        public static function compare(string $left, string $right, ?int $length = null): bool
1✔
325
        {
326
                if (class_exists('Normalizer', false)) {
1✔
327
                        $left = \Normalizer::normalize($left, \Normalizer::FORM_D); // form NFD is faster
1✔
328
                        $right = \Normalizer::normalize($right, \Normalizer::FORM_D); // form NFD is faster
1✔
329
                }
330

331
                if ($length < 0) {
1✔
332
                        $left = self::substring($left, $length, -$length);
1✔
333
                        $right = self::substring($right, $length, -$length);
1✔
334
                } elseif ($length !== null) {
1✔
335
                        $left = self::substring($left, 0, $length);
1✔
336
                        $right = self::substring($right, 0, $length);
1✔
337
                }
338

339
                return self::lower($left) === self::lower($right);
1✔
340
        }
341

342

343
        /**
344
         * Finds the common prefix of strings or returns empty string if the prefix was not found.
345
         * @param  string[]  $strings
346
         */
347
        public static function findPrefix(array $strings): string
1✔
348
        {
349
                $first = array_shift($strings);
1✔
350
                for ($i = 0; $i < strlen($first); $i++) {
1✔
351
                        foreach ($strings as $s) {
1✔
352
                                if (!isset($s[$i]) || $first[$i] !== $s[$i]) {
1✔
353
                                        while ($i && $first[$i - 1] >= "\x80" && $first[$i] >= "\x80" && $first[$i] < "\xC0") {
1✔
354
                                                $i--;
1✔
355
                                        }
356

357
                                        return substr($first, 0, $i);
1✔
358
                                }
359
                        }
360
                }
361

362
                return $first;
1✔
363
        }
364

365

366
        /**
367
         * Returns number of characters (not bytes) in UTF-8 string.
368
         * That is the number of Unicode code points which may differ from the number of graphemes.
369
         */
370
        public static function length(string $s): int
1✔
371
        {
372
                return match (true) {
373
                        extension_loaded('mbstring') => mb_strlen($s, 'UTF-8'),
1✔
UNCOV
374
                        extension_loaded('iconv') => iconv_strlen($s, 'UTF-8'),
×
375
                        default => strlen(@utf8_decode($s)), // deprecated
1✔
376
                };
377
        }
378

379

380
        /**
381
         * Removes all left and right side spaces (or the characters passed as second argument) from a UTF-8 encoded string.
382
         */
383
        public static function trim(string $s, string $charlist = self::TrimCharacters): string
1✔
384
        {
385
                $charlist = preg_quote($charlist, '#');
1✔
386
                return self::replace($s, '#^[' . $charlist . ']+|[' . $charlist . ']+$#Du', '');
1✔
387
        }
388

389

390
        /**
391
         * Pads a UTF-8 string to given length by prepending the $pad string to the beginning.
392
         * @param  non-empty-string  $pad
393
         */
394
        public static function padLeft(string $s, int $length, string $pad = ' '): string
1✔
395
        {
396
                $length = max(0, $length - self::length($s));
1✔
397
                $padLen = self::length($pad);
1✔
398
                return str_repeat($pad, (int) ($length / $padLen)) . self::substring($pad, 0, $length % $padLen) . $s;
1✔
399
        }
400

401

402
        /**
403
         * Pads UTF-8 string to given length by appending the $pad string to the end.
404
         * @param  non-empty-string  $pad
405
         */
406
        public static function padRight(string $s, int $length, string $pad = ' '): string
1✔
407
        {
408
                $length = max(0, $length - self::length($s));
1✔
409
                $padLen = self::length($pad);
1✔
410
                return $s . str_repeat($pad, (int) ($length / $padLen)) . self::substring($pad, 0, $length % $padLen);
1✔
411
        }
412

413

414
        /**
415
         * Reverses UTF-8 string.
416
         */
417
        public static function reverse(string $s): string
1✔
418
        {
419
                if (!extension_loaded('iconv')) {
1✔
UNCOV
420
                        throw new Nette\NotSupportedException(__METHOD__ . '() requires ICONV extension that is not loaded.');
×
421
                }
422

423
                return iconv('UTF-32LE', 'UTF-8', strrev(iconv('UTF-8', 'UTF-32BE', $s)));
1✔
424
        }
425

426

427
        /**
428
         * Returns part of $haystack before $nth occurence of $needle or returns null if the needle was not found.
429
         * Negative value means searching from the end.
430
         */
431
        public static function before(string $haystack, string $needle, int $nth = 1): ?string
1✔
432
        {
433
                $pos = self::pos($haystack, $needle, $nth);
1✔
434
                return $pos === null
1✔
435
                        ? null
1✔
436
                        : substr($haystack, 0, $pos);
1✔
437
        }
438

439

440
        /**
441
         * Returns part of $haystack after $nth occurence of $needle or returns null if the needle was not found.
442
         * Negative value means searching from the end.
443
         */
444
        public static function after(string $haystack, string $needle, int $nth = 1): ?string
1✔
445
        {
446
                $pos = self::pos($haystack, $needle, $nth);
1✔
447
                return $pos === null
1✔
448
                        ? null
1✔
449
                        : substr($haystack, $pos + strlen($needle));
1✔
450
        }
451

452

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

465

466
        /**
467
         * Returns position in characters of $nth occurence of $needle in $haystack or null if the needle was not found.
468
         */
469
        private static function pos(string $haystack, string $needle, int $nth = 1): ?int
1✔
470
        {
471
                if (!$nth) {
1✔
472
                        return null;
1✔
473
                } elseif ($nth > 0) {
1✔
474
                        if ($needle === '') {
1✔
475
                                return 0;
1✔
476
                        }
477

478
                        $pos = 0;
1✔
479
                        while (($pos = strpos($haystack, $needle, $pos)) !== false && --$nth) {
1✔
480
                                $pos++;
1✔
481
                        }
482
                } else {
483
                        $len = strlen($haystack);
1✔
484
                        if ($needle === '') {
1✔
485
                                return $len;
1✔
486
                        } elseif ($len === 0) {
1✔
487
                                return null;
1✔
488
                        }
489

490
                        $pos = $len - 1;
1✔
491
                        while (($pos = strrpos($haystack, $needle, $pos - $len)) !== false && ++$nth) {
1✔
492
                                $pos--;
1✔
493
                        }
494
                }
495

496
                return Helpers::falseToNull($pos);
1✔
497
        }
498

499

500
        /**
501
         * Divides the string into arrays according to the regular expression. Expressions in parentheses will be captured and returned as well.
502
         */
503
        public static function split(
1✔
504
                string $subject,
505
                #[Language('RegExp')]
506
                string $pattern,
507
                bool|int $captureOffset = false,
508
                bool $skipEmpty = false,
509
                int $limit = -1,
510
                bool $utf8 = false,
511
        ): array
512
        {
513
                $flags = is_int($captureOffset)  // back compatibility
1✔
514
                        ? $captureOffset
1✔
515
                        : ($captureOffset ? PREG_SPLIT_OFFSET_CAPTURE : 0) | ($skipEmpty ? PREG_SPLIT_NO_EMPTY : 0);
1✔
516

517
                $pattern .= $utf8 ? 'u' : '';
1✔
518
                $m = self::pcre('preg_split', [$pattern, $subject, $limit, $flags | PREG_SPLIT_DELIM_CAPTURE]);
1✔
519
                return $utf8 && $captureOffset
1✔
520
                        ? self::bytesToChars($subject, [$m])[0]
1✔
521
                        : $m;
1✔
522
        }
523

524

525
        /**
526
         * Searches the string for the part matching the regular expression and returns
527
         * an array with the found expression and individual subexpressions, or `null`.
528
         */
529
        public static function match(
1✔
530
                string $subject,
531
                #[Language('RegExp')]
532
                string $pattern,
533
                bool|int $captureOffset = false,
534
                int $offset = 0,
535
                bool $unmatchedAsNull = false,
536
                bool $utf8 = false,
537
        ): ?array
538
        {
539
                $flags = is_int($captureOffset) // back compatibility
1✔
540
                        ? $captureOffset
1✔
541
                        : ($captureOffset ? PREG_OFFSET_CAPTURE : 0) | ($unmatchedAsNull ? PREG_UNMATCHED_AS_NULL : 0);
1✔
542

543
                if ($utf8) {
1✔
544
                        $offset = strlen(self::substring($subject, 0, $offset));
1✔
545
                        $pattern .= 'u';
1✔
546
                }
547

548
                if ($offset > strlen($subject)) {
1✔
549
                        return null;
1✔
550
                } elseif (!self::pcre('preg_match', [$pattern, $subject, &$m, $flags, $offset])) {
1✔
551
                        return null;
1✔
552
                } elseif ($utf8 && $captureOffset) {
1✔
553
                        return self::bytesToChars($subject, [$m])[0];
1✔
554
                } else {
555
                        return $m;
1✔
556
                }
557
        }
558

559

560
        /**
561
         * Searches the string for all occurrences matching the regular expression and
562
         * returns an array of arrays containing the found expression and each subexpression.
563
         * @return ($lazy is true ? \Generator<int, array> : array[])
564
         */
565
        public static function matchAll(
1✔
566
                string $subject,
567
                #[Language('RegExp')]
568
                string $pattern,
569
                bool|int $captureOffset = false,
570
                int $offset = 0,
571
                bool $unmatchedAsNull = false,
572
                bool $patternOrder = false,
573
                bool $utf8 = false,
574
                bool $lazy = false,
575
        ): array|\Generator
576
        {
577
                if ($utf8) {
1✔
578
                        $offset = strlen(self::substring($subject, 0, $offset));
1✔
579
                        $pattern .= 'u';
1✔
580
                }
581

582
                if ($lazy) {
1✔
583
                        $flags = PREG_OFFSET_CAPTURE | ($unmatchedAsNull ? PREG_UNMATCHED_AS_NULL : 0);
1✔
584
                        return (function () use ($utf8, $captureOffset, $flags, $subject, $pattern, $offset) {
1✔
585
                                $counter = 0;
1✔
586
                                while (
587
                                        $offset <= strlen($subject) - ($counter ? 1 : 0)
1✔
588
                                        && self::pcre('preg_match', [$pattern, $subject, &$m, $flags, $offset])
1✔
589
                                ) {
590
                                        $offset = $m[0][1] + max(1, strlen($m[0][0]));
1✔
591
                                        if (!$captureOffset) {
1✔
592
                                                $m = array_map(fn($item) => $item[0], $m);
1✔
593
                                        } elseif ($utf8) {
1✔
594
                                                $m = self::bytesToChars($subject, [$m])[0];
1✔
595
                                        }
596
                                        yield $counter++ => $m;
1✔
597
                                }
598
                        })();
1✔
599
                }
600

601
                if ($offset > strlen($subject)) {
1✔
602
                        return [];
1✔
603
                }
604

605
                $flags = is_int($captureOffset) // back compatibility
1✔
606
                        ? $captureOffset
1✔
607
                        : ($captureOffset ? PREG_OFFSET_CAPTURE : 0) | ($unmatchedAsNull ? PREG_UNMATCHED_AS_NULL : 0) | ($patternOrder ? PREG_PATTERN_ORDER : 0);
1✔
608

609
                self::pcre('preg_match_all', [
1✔
610
                        $pattern, $subject, &$m,
1✔
611
                        ($flags & PREG_PATTERN_ORDER) ? $flags : ($flags | PREG_SET_ORDER),
1✔
612
                        $offset,
1✔
613
                ]);
614
                return $utf8 && $captureOffset
1✔
615
                        ? self::bytesToChars($subject, $m)
1✔
616
                        : $m;
1✔
617
        }
618

619

620
        /**
621
         * Replaces all occurrences matching regular expression $pattern which can be string or array in the form `pattern => replacement`.
622
         */
623
        public static function replace(
1✔
624
                string $subject,
625
                #[Language('RegExp')]
626
                string|array $pattern,
627
                string|callable $replacement = '',
628
                int $limit = -1,
629
                bool $captureOffset = false,
630
                bool $unmatchedAsNull = false,
631
                bool $utf8 = false,
632
        ): string
633
        {
634
                if (is_object($replacement) || is_array($replacement)) {
1✔
635
                        if (!is_callable($replacement, false, $textual)) {
1✔
UNCOV
636
                                throw new Nette\InvalidStateException("Callback '$textual' is not callable.");
×
637
                        }
638

639
                        $flags = ($captureOffset ? PREG_OFFSET_CAPTURE : 0) | ($unmatchedAsNull ? PREG_UNMATCHED_AS_NULL : 0);
1✔
640
                        if ($utf8) {
1✔
641
                                $pattern .= 'u';
1✔
642
                                if ($captureOffset) {
1✔
643
                                        $replacement = fn($m) => $replacement(self::bytesToChars($subject, [$m])[0]);
1✔
644
                                }
645
                        }
646

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

649
                } elseif (is_array($pattern) && is_string(key($pattern))) {
1✔
650
                        $replacement = array_values($pattern);
1✔
651
                        $pattern = array_keys($pattern);
1✔
652
                }
653

654
                if ($utf8) {
1✔
655
                        $pattern = array_map(fn($item) => $item . 'u', (array) $pattern);
1✔
656
                }
657

658
                return self::pcre('preg_replace', [$pattern, $replacement, $subject, $limit]);
1✔
659
        }
660

661

662
        private static function bytesToChars(string $s, array $groups): array
1✔
663
        {
664
                $lastBytes = $lastChars = 0;
1✔
665
                foreach ($groups as &$matches) {
1✔
666
                        foreach ($matches as &$match) {
1✔
667
                                if ($match[1] > $lastBytes) {
1✔
668
                                        $lastChars += self::length(substr($s, $lastBytes, $match[1] - $lastBytes));
1✔
669
                                } elseif ($match[1] < $lastBytes) {
1✔
670
                                        $lastChars -= self::length(substr($s, $match[1], $lastBytes - $match[1]));
1✔
671
                                }
672

673
                                $lastBytes = $match[1];
1✔
674
                                $match[1] = $lastChars;
1✔
675
                        }
676
                }
677

678
                return $groups;
1✔
679
        }
680

681

682
        /** @internal */
683
        public static function pcre(string $func, array $args)
1✔
684
        {
685
                $res = Callback::invokeSafe($func, $args, function (string $message) use ($args): void {
1✔
686
                        // compile-time error, not detectable by preg_last_error
687
                        throw new RegexpException($message . ' in pattern: ' . implode(' or ', (array) $args[0]));
1✔
688
                });
1✔
689

690
                if (($code = preg_last_error()) // run-time error, but preg_last_error & return code are liars
1✔
691
                        && ($res === null || !in_array($func, ['preg_filter', 'preg_replace_callback', 'preg_replace'], true))
1✔
692
                ) {
693
                        throw new RegexpException(preg_last_error_msg()
1✔
694
                                . ' (pattern: ' . implode(' or ', (array) $args[0]) . ')', $code);
1✔
695
                }
696

697
                return $res;
1✔
698
        }
699
}
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

© 2025 Coveralls, Inc