grapheme_extract
(PHP 5 >= 5.3.0, PHP 7, PECL intl >= 1.0.0)
grapheme_extract — Function to extract a sequence of default grapheme clusters from a text buffer, which must be encoded in UTF-8
Description
Procedural style
$haystack
, int $size
[, int $extract_type
[, int $start
= 0
[, int &$next
]]] ) : stringFunction to extract a sequence of default grapheme clusters from a text buffer, which must be encoded in UTF-8.
Parameters
-
haystack
-
String to search.
-
size
-
Maximum number items - based on the $extract_type - to return.
-
extract_type
-
Defines the type of units referred to by the $size parameter:
- GRAPHEME_EXTR_COUNT (default) - $size is the number of default grapheme clusters to extract.
- GRAPHEME_EXTR_MAXBYTES - $size is the maximum number of bytes returned.
- GRAPHEME_EXTR_MAXCHARS - $size is the maximum number of UTF-8 characters returned.
-
start
-
Starting position in $haystack in bytes - if given, it must be zero or a positive value that is less than or equal to the length of $haystack in bytes, or a negative value that counts from the end of $haystack. If $start does not point to the first byte of a UTF-8 character, the start position is moved to the next character boundary.
-
next
-
Reference to a value that will be set to the next starting position. When the call returns, this may point to the first byte position past the end of the string.
Return Values
A string starting at offset $start and ending on a default grapheme cluster boundary that conforms to the $size and $extract_type specified.
Examples
Example #1 grapheme_extract() example
<?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));
?>
The above example will output:
o%CC%88
See Also
- grapheme_substr() - Return part of a string
- » Unicode Text Segmentation: Grapheme Cluster Boundaries
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-grapheme-extract.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.