デフォルトの書記素クラスタシーケンスをテキストバッファから取り出す関数。 テキストは UTF-8 でエンコードされている必要があります

# grapheme_extract

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

grapheme_extract — デフォルトの書記素クラスタシーケンスをテキストバッファから取り出す関数。 テキストは UTF-8 でエンコードされている必要があります

### 説明

手続き型

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

デフォルトの書記素クラスタシーケンスをテキストバッファから取り出す関数です。 テキストは UTF-8 でエンコードされている必要があります。

### パラメータ

`haystack`

  検索する文字列。

`size`

  返す項目 (`type` に基づく) の最大数。

`type`

  `size` パラメータの単位の形式を指定します。

  - GRAPHEME_EXTR_COUNT (デフォルト) - `size` は、 抽出するデフォルト書記素クラスタの数です。
  - GRAPHEME_EXTR_MAXBYTES - `size` は、返すバイト数の最大値です。
  - GRAPHEME_EXTR_MAXCHARS - `size` は、返す UTF-8 文字数の最大値です。
`offset`

  `haystack` 内での開始位置をバイト数で指定します。 指定する場合は、0 から `haystack` のバイト数までの値でなければなりません。 負の値を指定すると、`haystack` の末尾からバイト数を数えます。 `offset` が指す位置が UTF-8 文字の先頭バイトでない場合は、 その次の文字の先頭から開始します。

`next`

  次の開始位置への参照が設定されます。 この関数をコールすると、文字列の最後の部分の先頭バイトを指すことになります。

### 戻り値

オフセット `offset` から始まり、 指定した `size` と `type` を満たす、 デフォルトの書記素クラスタバウンダリで終わる文字列を返します。 失敗した場合に `false` を返します

### 変更履歴

バージョン | 説明
--- | ---
7.1.0 | 負の `offset` をサポートするようになりました。

### 例

例1 grapheme_extract() の例

    <?php

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

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

    ?>

上の例の出力は以下となります。

    o%CC%88

### 参考

- grapheme_substr() - 部分文字列を返す
- » Unicode Text Segmentation: Grapheme Cluster Boundaries

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open