Skip to content

Commit c72324d

Browse files
Ayeshnicolas-grekas
Ayesh
authored and
nicolas-grekas
committed
[PHP 8.4][Intl] Add grapheme_str_split
Add a polyfill for the `grapheme_str_split` function added in PHP 8.4. Requires PHP 7.3, because the polyfill is based on `\X` Regex, and it only works properly on PCRE2, which [only comes with PHP 7.3+](https://php.watch/versions/7.3/pcre2). Further, there are some cases that the polyfill cannot split complex characters (such as two consecutive country flag Emojis). This is now fixed in [PCRE2Project/pcre2#410](PCRE2Project/pcre2#410). However, this change will likely only make it to PHP 8.4. References: - [RFC: Grapheme cluster for `str_split` function: `grapheme_str_split`](https://wiki.php.net/rfc/grapheme_str_split) - [PHP.Watch: PHP 8.4: New `grapheme_str_split` function](https://php.watch/versions/8.4/grapheme_str_split)
1 parent a640137 commit c72324d

File tree

12 files changed

+169
-3
lines changed

12 files changed

+169
-3
lines changed

‎README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ Polyfills are provided for:
7272
- the `Deprecated` attribute introduced in PHP 8.4;
7373
- the `mb_trim`, `mb_ltrim` and `mb_rtrim` functions introduced in PHP 8.4;
7474
- the `CURL_HTTP_VERSION_3` and `CURL_HTTP_VERSION_3ONLY` constants introduced in PHP 8.4;
75+
- the `grapheme_str_split` function introduced in PHP 8.4;
7576
- the `get_error_handler` and `get_exception_handler` functions introduced in PHP 8.5;
7677
- the `NoDiscard` attribute introduced in PHP 8.5;
7778
- the `array_first` and `array_last` functions introduced in PHP 8.5;

‎src/Intl/Grapheme/Grapheme.php

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
* - grapheme_strrpos - Find position (in grapheme units) of last occurrence of a string
2727
* - grapheme_strstr - Returns part of haystack string from the first occurrence of needle to the end of haystack
2828
* - grapheme_substr - Return part of a string
29+
* - grapheme_str_split - Splits a string into an array of individual or chunks of graphemes
2930
*
3031
* @author Nicolas Grekas <[email protected]>
3132
*
@@ -191,6 +192,37 @@ public static function grapheme_strstr($s, $needle, $beforeNeedle = false)
191192
return mb_strstr($s, $needle, $beforeNeedle, 'UTF-8');
192193
}
193194

195+
public static function grapheme_str_split($s, $len = 1)
196+
{
197+
if (0 > $len || 1073741823 < $len) {
198+
if (80000 > \PHP_VERSION_ID) {
199+
return false;
200+
}
201+
202+
throw new \ValueError('grapheme_str_split(): Argument #2 ($length) must be greater than 0 and less than or equal to 1073741823.');
203+
}
204+
205+
if ('' === $s) {
206+
return [];
207+
}
208+
209+
if (!preg_match_all('/('.SYMFONY_GRAPHEME_CLUSTER_RX.')/u', $s, $matches)) {
210+
return false;
211+
}
212+
213+
if (1 === $len) {
214+
return $matches[0];
215+
}
216+
217+
$chunks = array_chunk($matches[0], $len);
218+
219+
foreach ($chunks as &$chunk) {
220+
$chunk = implode('', $chunk);
221+
}
222+
223+
return $chunks;
224+
}
225+
194226
private static function grapheme_position($s, $needle, $offset, $mode)
195227
{
196228
$needle = (string) $needle;

‎src/Intl/Grapheme/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ This component provides a partial, native PHP implementation of the
2121
- [`grapheme_strstr`](https://php.net/grapheme_strstr): Returns part of haystack string from
2222
the first occurrence of needle to the end of haystack
2323
- [`grapheme_substr`](https://php.net/grapheme_substr): Return part of a string
24+
- [`grapheme_str_split](https://php.net/grapheme_str_split): Splits a string into an array of individual or chunks of graphemes
2425

2526
More information can be found in the
2627
[main Polyfill README](https://github.com/symfony/polyfill/blob/main/README.md).

‎src/Intl/Grapheme/bootstrap.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,6 @@ function grapheme_strstr($haystack, $needle, $beforeNeedle = false) { return p\G
5656
if (!function_exists('grapheme_substr')) {
5757
function grapheme_substr($string, $offset, $length = null) { return p\Grapheme::grapheme_substr($string, $offset, $length); }
5858
}
59+
if (!function_exists('grapheme_str_split')) {
60+
function grapheme_str_split($string, $length = 1) { return p\Grapheme::grapheme_str_split($string, $length); }
61+
}

‎src/Intl/Grapheme/bootstrap80.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,6 @@ function grapheme_strstr(?string $haystack, ?string $needle, ?bool $beforeNeedle
4848
if (!function_exists('grapheme_substr')) {
4949
function grapheme_substr(?string $string, ?int $offset, ?int $length = null): string|false { return p\Grapheme::grapheme_substr((string) $string, (int) $offset, $length); }
5050
}
51+
if (!function_exists('grapheme_str_split')) {
52+
function grapheme_str_split(string $string, int $length = 1): array|false { return p\Grapheme::grapheme_str_split($string, $length); }
53+
}

‎src/Php84/Php84.php

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,4 +174,34 @@ private static function mb_internal_trim(string $regex, string $string, ?string
174174

175175
return mb_convert_encoding($string, $encoding, 'UTF-8');
176176
}
177+
178+
public static function grapheme_str_split(string $string, int $length)
179+
{
180+
if (0 > $length || 1073741823 < $length) {
181+
throw new \ValueError('grapheme_str_split(): Argument #2 ($length) must be greater than 0 and less than or equal to 1073741823.');
182+
}
183+
184+
if ('' === $string) {
185+
return [];
186+
}
187+
188+
$regex = ((float) \PCRE_VERSION < 10 ? (float) \PCRE_VERSION >= 8.32 : (float) \PCRE_VERSION >= 10.39)
189+
? '\X'
190+
: '(?:\r\n|(?:[ -~\x{200C}\x{200D}]|[ᆨ-ᇹ]+|[ᄀ-ᅟ]*(?:[가개갸걔거게겨계고과괘괴교구궈궤귀규그긔기까깨꺄꺠꺼께껴꼐꼬꽈꽤꾀꾜꾸꿔꿰뀌뀨끄끠끼나내냐냬너네녀녜노놔놰뇌뇨누눠눼뉘뉴느늬니다대댜댸더데뎌뎨도돠돼되됴두둬뒈뒤듀드듸디따때땨떄떠떼뗘뗴또똬뙈뙤뚀뚜뚸뛔뛰뜌뜨띄띠라래랴럐러레려례로롸뢔뢰료루뤄뤠뤼류르릐리마매먀먜머메며몌모뫄뫠뫼묘무뭐뭬뮈뮤므믜미바배뱌뱨버베벼볘보봐봬뵈뵤부붜붸뷔뷰브븨비빠빼뺘뺴뻐뻬뼈뼤뽀뽜뽸뾔뾰뿌뿨쀄쀠쀼쁘쁴삐사새샤섀서세셔셰소솨쇄쇠쇼수숴쉐쉬슈스싀시싸쌔쌰썌써쎄쎠쎼쏘쏴쐐쐬쑈쑤쒀쒜쒸쓔쓰씌씨아애야얘어에여예오와왜외요우워웨위유으의이자재쟈쟤저제져졔조좌좨죄죠주줘줴쥐쥬즈즤지짜째쨔쨰쩌쩨쪄쪠쪼쫘쫴쬐쬬쭈쭤쮀쮜쮸쯔쯰찌차채챠챼처체쳐쳬초촤쵀최쵸추춰췌취츄츠츼치카캐캬컈커케켜켸코콰쾌쾨쿄쿠쿼퀘퀴큐크킈키타태탸턔터테텨톄토톼퇘퇴툐투퉈퉤튀튜트틔티파패퍄퍠퍼페펴폐포퐈퐤푀표푸풔풰퓌퓨프픠피하해햐햬허헤혀혜호화홰회효후훠훼휘휴흐희히]?[ᅠ-ᆢ]+|[가-힣])[ᆨ-ᇹ]*|[ᄀ-ᅟ]+|[^\p{Cc}\p{Cf}\p{Zl}\p{Zp}])[\p{Mn}\p{Me}\x{09BE}\x{09D7}\x{0B3E}\x{0B57}\x{0BBE}\x{0BD7}\x{0CC2}\x{0CD5}\x{0CD6}\x{0D3E}\x{0D57}\x{0DCF}\x{0DDF}\x{200C}\x{200D}\x{1D165}\x{1D16E}-\x{1D172}]*|[\p{Cc}\p{Cf}\p{Zl}\p{Zp}])';
191+
192+
if (!preg_match_all('/'. $regex .'/u', $string, $matches)) {
193+
return false;
194+
}
195+
196+
if (1 === $length) {
197+
return $matches[0];
198+
}
199+
200+
$chunks = array_chunk($matches[0], $length);
201+
foreach ($chunks as &$chunk) {
202+
$chunk = implode('', $chunk);
203+
}
204+
205+
return $chunks;
206+
}
177207
}

‎src/Php84/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,13 @@ Symfony Polyfill / Php84
33

44
This component provides features added to PHP 8.4 core:
55

6-
- [`mb_ucfirst` and `mb_lcfirst`](https://wiki.php.net/rfc/mb_ucfirst)
76
- [`array_find`, `array_find_key`, `array_any` and `array_all`](https://wiki.php.net/rfc/array_find)
87
- [`Deprecated`](https://wiki.php.net/rfc/deprecated_attribute)
98
- `CURL_HTTP_VERSION_3` and `CURL_HTTP_VERSION_3ONLY` constants
109
- [`fpow`](https://wiki.php.net/rfc/raising_zero_to_power_of_negative_number)
10+
- [`grapheme_str_split`](https://wiki.php.net/rfc/grapheme_str_split)
1111
- [`mb_trim`, `mb_ltrim` and `mb_rtrim`](https://wiki.php.net/rfc/mb_trim)
12+
- [`mb_ucfirst` and `mb_lcfirst`](https://wiki.php.net/rfc/mb_ucfirst)
1213

1314
More information can be found in the
1415
[main Polyfill README](https://github.com/symfony/polyfill/blob/main/README.md).

‎src/Php84/bootstrap.php

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,3 +66,11 @@ function mb_ltrim(string $string, ?string $characters = null, ?string $encoding
6666
function mb_rtrim(string $string, ?string $characters = null, ?string $encoding = null): string { return p\Php84::mb_rtrim($string, $characters, $encoding); }
6767
}
6868
}
69+
70+
if (\PHP_VERSION_ID >= 80200) {
71+
return require __DIR__.'/bootstrap82.php';
72+
}
73+
74+
if (extension_loaded('intl') && !function_exists('grapheme_str_split')) {
75+
function grapheme_str_split(string $string, int $length = 1) { return p\Php84::grapheme_str_split($string, $length); }
76+
}

‎src/Php84/bootstrap82.php

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <[email protected]>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
use Symfony\Polyfill\Php84 as p;
13+
14+
if (\PHP_VERSION_ID >= 80400) {
15+
return;
16+
}
17+
18+
if (extension_loaded('intl') && !function_exists('grapheme_str_split')) {
19+
function grapheme_str_split(string $string, int $length = 1): array|false { return p\Php84::grapheme_str_split($string, $length); }
20+
}

‎src/Util/TestListenerTrait.php

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,14 @@ public function startTestSuite($mainSuite)
4949
}
5050
$testedClass = new \ReflectionClass($m[1].$m[2]);
5151
$bootstrap = \dirname($testedClass->getFileName()).'/bootstrap';
52-
$bootstrap = new \SplFileObject($bootstrap.(\PHP_VERSION_ID >= 80000 && file_exists($bootstrap.'80.php') ? '80' : '').'.php');
52+
if (\PHP_VERSION_ID >= 80200 && file_exists($bootstrap.'82.php')) {
53+
$bootstrap .= '82';
54+
} elseif (\PHP_VERSION_ID >= 80100 && file_exists($bootstrap.'81.php')) {
55+
$bootstrap .= '81';
56+
} elseif (\PHP_VERSION_ID >= 80000 && file_exists($bootstrap.'80.php')) {
57+
$bootstrap .= '80';
58+
}
59+
$bootstrap = new \SplFileObject($bootstrap.'.php');
5360
$newWarnings = 0;
5461
$defLine = null;
5562

@@ -137,7 +144,7 @@ function {$f['name']}{$f['signature']}
137144
];
138145

139146
if (strtr($polyfillSignature, $map) !== str_replace('?', '', $originalSignature)) {
140-
$warnings[] = TestListener::warning("Incompatible signature for PHP >= 8:\n- {$f['name']}$originalSignature\n+ {$f['name']}$polyfillSignature");
147+
$warnings[] = TestListener::warning("Incompatible signature for PHP >= 8 in {$bootstrap->getPathname()}:\n- {$f['name']}$originalSignature\n+ {$f['name']}$polyfillSignature");
141148
}
142149
}
143150
}

‎tests/Intl/Grapheme/GraphemeTest.php

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,4 +209,34 @@ public function testGraphemeStrstr()
209209
$this->assertSame('국어', grapheme_strstr('한국어', '국'));
210210
$this->assertSame('ÉJÀ', grapheme_stristr('DÉJÀ', 'é'));
211211
}
212+
213+
/**
214+
* @dataProvider graphemeStrSplitDataProvider
215+
*/
216+
public function testGraphemeStrSplit(string $string, int $length, array $expectedValues)
217+
{
218+
$this->assertSame($expectedValues, grapheme_str_split($string, $length));
219+
}
220+
221+
public static function graphemeStrSplitDataProvider(): array
222+
{
223+
$cases = [
224+
['', 1, []],
225+
['PHP', 1, ['P', 'H', 'P']],
226+
['你好', 1, ['你', '好']],
227+
['අයේෂ්', 1, ['අ', 'යේ', 'ෂ්']],
228+
['สวัสดี', 2, ['สวั', 'สดี']],
229+
];
230+
231+
if (70300 <= PHP_VERSION_ID) {
232+
$cases[] = ['土下座🙇‍♀を', 1, ["土", "下", "座", "🙇‍♀", "を"]];
233+
}
234+
235+
// Fixed in https://github.com/PCRE2Project/pcre2/issues/410
236+
if (defined('PCRE_VERSION_MAJOR') && PCRE_VERSION_MAJOR > 10 && PCRE_VERSION_MINOR > 44) {
237+
$cases[] = ['👭🏻👰🏿‍♂️', 2, ['👭🏻', '👰🏿‍♂️']];
238+
}
239+
240+
return $cases;
241+
}
212242
}

‎tests/Php84/Php84Test.php

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -663,4 +663,34 @@ public static function fpowProvider(): iterable
663663
yield [NAN, -INF, NAN];
664664
yield [NAN, NAN, NAN];
665665
}
666+
667+
/**
668+
* @dataProvider graphemeStrSplitDataProvider
669+
*/
670+
public function testGraphemeStrSplit(string $string, int $length, array $expectedValues)
671+
{
672+
$this->assertSame($expectedValues, grapheme_str_split($string, $length));
673+
}
674+
675+
public static function graphemeStrSplitDataProvider(): array
676+
{
677+
$cases = [
678+
['', 1, []],
679+
['PHP', 1, ['P', 'H', 'P']],
680+
['你好', 1, ['你', '好']],
681+
['අයේෂ්', 1, ['අ', 'යේ', 'ෂ්']],
682+
['สวัสดี', 2, ['สวั', 'สดี']],
683+
];
684+
685+
if (70300 <= PHP_VERSION_ID) {
686+
$cases[] = ['土下座🙇‍♀を', 1, ["土", "下", "座", "🙇‍♀", "を"]];
687+
}
688+
689+
// Fixed in https://github.com/PCRE2Project/pcre2/issues/410
690+
if (defined('PCRE_VERSION_MAJOR') && 10 < PCRE_VERSION_MAJOR && 44 < PCRE_VERSION_MINOR) {
691+
$cases[] = ['👭🏻👰🏿‍♂️', 2, ['👭🏻', '👰🏿‍♂️']];
692+
}
693+
694+
return $cases;
695+
}
666696
}

0 commit comments

Comments
 (0)