# 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