grapheme_extract

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

grapheme_extract — Extrai uma sequência de grupos padrão de grafemas de um buffer de texto em UTF-8

Descrição

Estilo procedural

grapheme_extract(
    string $haystack,
    int $size,
    int $type = GRAPHEME_EXTR_COUNT,
    int $offset = 0,
    int &$next = null
): string|false

Esta função extrai uma sequência de grupos padrão de grafemas a partir de um buffer de texto codificado em UTF-8.

Parâmetros

haystack

A string onde a pesquisa será feita.

size

Número máximo de itens - baseado no tipo type - a retornar.

type

Define o tipo de unidades referidas pelo parâmetro size:

GRAPHEME_EXTR_COUNT (padrão) - size é o número de grupos padrão de grafemas a extrair.
GRAPHEME_EXTR_MAXBYTES - size é o número máximo de bytes retornados.
GRAPHEME_EXTR_MAXCHARS - size é o número máximo de caracteres UTF-8 retornados.

offset

Posição inicial no haystack em bytes - se informado, precisa ser zero ou um inteiro positivo que seja menor ou igual ao comprimento de haystack em bytes, ou um valor negativo que conta a partir do final de haystack. Se offset não apontar para o primeiro byte de um caractere UTF-8, a posição de início é movida para o primeiro byte do caractere seguinte.

next

Referência a um valor que será definido para a próxima posição de início. Quando a chamada retornar, esta variável poderá apontar para a primeira posição em bytes após o final da string.

Valor Retornado

Um string com deslocamento em offset e terminando em um limite de grupo padrão de grafema que esteja em conformidade com os parâmetros size e type especificados, ou false em caso de falha.

Registro de Alterações

Versão	Descrição
7.1.0	Suporte para `offset` negativo foi adicionado.

Exemplos

Exemplo #1 Exemplo de grapheme_extract()

<?php

$char_a_ring_nfd = "a\xCC\x8A";  // 'LATIN SMALL LETTER A WITH RING ABOVE' (U+00E5) NFD
$char_o_diaeresis_nfd = "o\xCC\x88"; // 'LATIN SMALL LETTER O WITH DIAERESIS' (U+00F6) NFD

print urlencode(grapheme_extract( $char_a_ring_nfd . $char_o_diaeresis_nfd, 1, GRAPHEME_EXTR_COUNT, 2));

?>

O exemplo acima produzirá:

o%CC%88

Veja Também

grapheme_substr() - Retorna parte de uma string
» Unicode Text Segmentation: Grapheme Cluster Boundaries

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