grapheme_extract

(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0)

grapheme_extract — Función para extraer una secuencia de un clúster de grafemas predeterminados desde un buffer de texto, que puede estar codificado en UTF-8

Descripción

Estilo por procedimientos

grapheme_extract(
    string $haystack,
    int $size,
    int $extract_type = ?,
    int $start = 0,
    int &$next = ?
): string

Función para extraer una secuencia de un clúster de grafemas predeterminados desde un buffer de texto, que puede estar codificado en UTF-8.

Parámetros

haystack

La cadena a buscar.

size

Número máximo de elementos -basado en el parámetro $extract_type- a devolver.

extract_type

Define el tipo de unidades mencionadas por el parámetro $size:

GRAPHEME_EXTR_COUNT (predeterminado) - $size es el número predeterminado de grupos de grafemas a extraer.
GRAPHEME_EXTR_MAXBYTES - $size es el número máximo de bytes devueltos.
GRAPHEME_EXTR_MAXCHARS - $size es el número máximo de caracteres UTF-8 devueltos.

start

Posición de inicio del parámetro $haystack en bytes -si se proporciona, debe ser cero o un valor positivo que sea menor o igual que la longitud del parámetro $haystack en bytes. Si $start no apunta al primer byte de un carácter UTF-8, la posición de inicio se mueve al límite del siguiente carácter.

next

Una referencia a un valor que será establecido a la posición de inicio siguiente. Cuando la funcion devuelve, este parámetro puede apuntar a la posición del primer byte después del final de la cadena.

Valores devueltos

Una cadena que empieza en el índice $start y termina en un límite de un grupo de grafemas predeterminado que se ajusta al $size y $extract_type especificados.

Ejemplos

Ejemplo #1 Ejemplo de grapheme_extract()

<?php

$carácter_a_anillo_nfd = "a\xCC\x8A";  // 'LETRA MINÚSCULA LATINA A CON ANILLO SUPERIOR' (U+00E5) forma de normalización "D"
$carácter_o_diéresis_nfd = "o\xCC\x88"; // 'LETRA MINÚSCULA LATINA O CON DIÉRESIS' (U+00F6) forma de normalización "D"

print urlencode(grapheme_extract( $carácter_a_anillo_nfd . $carácter_o_diéresis_nfd, 1, GRAPHEME_EXTR_COUNT, 2));

?>

El resultado del ejemplo sería:

o%CC%88

Ver también

grapheme_substr() - Devolver parte de una cadena
» Segementación de Texto Unicode: Límites de Grupos de Grafemas

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 3 notes

down

AJH ¶

13 years ago

Here's how to use grapheme_extract() to loop across a UTF-8 string character by character.

<?php

$str = "سabcक’…";
// if the previous line didn't come through, the string contained:
//U+0633,U+0061,U+0062,U+0063,U+0915,U+2019,U+2026

$n = 0;

for (    $start = 0, $next = 0, $maxbytes = strlen($str), $c = '';
        $start < $maxbytes;
        $c = grapheme_extract($str, 1, GRAPHEME_EXTR_MAXCHARS , ($start = $next), $next)
    )
{
    if (empty($c))
        continue;
    echo "This utf8 character is " . strlen($c) . " bytes long and its first byte is " . ord($c[0]) . "\n";
    $n++;
}
echo "$n UTF-8 characters in a string of $maxbytes bytes!\n";
// Should print: 7 UTF8 characters in a string of 14 bytes!
?>

down

Philo ¶

1 year ago

The other comments on this page were helpful for me.
However, consider using something better than empty($value) when checking the value returned by grapheme_extract since it could as well return something like "0" (which of course evaluates to false).

down

yevgen dot grytsay at gmail dot com ¶

4 years ago

Looping through grapheme clusters:

<?php

// Example taken from Rust documentation: https://doc.rust-lang.org/book/ch08-02-strings.html#bytes-and-scalar-values-and-grapheme-clusters-oh-my
$str = "नमस्ते";
// Alternatively:
//$str = pack('C*', ...[224, 164, 168, 224, 164, 174, 224, 164, 184, 224, 165, 141, 224, 164, 164, 224, 165, 135]);
$next = 0;
$maxbytes = strlen($str);

var_dump($str);

while ($next < $maxbytes) {
    $char = grapheme_extract($str, 1, GRAPHEME_EXTR_COUNT, $next, $next);
    if (empty($char)) {
        continue;
    }
    echo "{$char} - This utf8 character is " . strlen($char) . ' bytes long', PHP_EOL;
}

//string(18) "नमस्ते"
//न - This utf8 character is 3 bytes long
//म - This utf8 character is 3 bytes long
//स् - This utf8 character is 6 bytes long
//ते - This utf8 character is 6 bytes long
?>

＋add a note