From 379f0fd299dfd2a9868fbed1da90181ed085076f Mon Sep 17 00:00:00 2001 From: Stanislav Malyshev Date: Fri, 18 Apr 2008 17:04:49 +0000 Subject: [PATCH] merge docs for graphemes git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@257829 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/intl/functions/grapheme-extract.xml | 30 ++++++++--- .../intl/functions/grapheme-extractb.xml | 34 ++++++++++--- reference/intl/functions/grapheme-stripos.xml | 36 +++++++++---- reference/intl/functions/grapheme-stristr.xml | 33 +++++++++--- reference/intl/functions/grapheme-strlen.xml | 23 ++++++--- reference/intl/functions/grapheme-strpos.xml | 35 +++++++++---- .../intl/functions/grapheme-strripos.xml | 36 +++++++++---- reference/intl/functions/grapheme-strrpos.xml | 35 +++++++++---- reference/intl/functions/grapheme-strstr.xml | 30 ++++++++--- reference/intl/functions/grapheme-substr.xml | 50 ++++++++++++------- 10 files changed, 252 insertions(+), 90 deletions(-) diff --git a/reference/intl/functions/grapheme-extract.xml b/reference/intl/functions/grapheme-extract.xml index 2ea877063b..f2f9fb8e42 100644 --- a/reference/intl/functions/grapheme-extract.xml +++ b/reference/intl/functions/grapheme-extract.xml @@ -1,5 +1,5 @@ - + grapheme_extract @@ -27,7 +27,7 @@ haystack - string to search + String to search. @@ -35,7 +35,7 @@ size - maximum number of grapheme clusters to return + Maximum number of grapheme clusters to return. @@ -43,7 +43,10 @@ start - starting position in $haystack in bytes + 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. The default is zero. If $start does not point to the first byte of a UTF-8 + character, the start position is moved to the next character boundary. @@ -66,7 +69,12 @@ ]]> @@ -74,7 +82,7 @@ TODO &example.outputs; @@ -82,7 +90,15 @@ TODO &reftitle.seealso; -TODO + + grapheme_extractb + grapheme_substr + + + Unicode Text Segmentation: Grapheme Cluster Boundaries + + + diff --git a/reference/intl/functions/grapheme-extractb.xml b/reference/intl/functions/grapheme-extractb.xml index 7a90edcf54..4957991453 100644 --- a/reference/intl/functions/grapheme-extractb.xml +++ b/reference/intl/functions/grapheme-extractb.xml @@ -1,5 +1,5 @@ - + grapheme_extractb @@ -15,7 +15,8 @@ intstart - Function to extract a sequence of default grapheme clusters from a text buffer, which must be encoded in UTF-8. + Function to extract a sequence of default grapheme clusters from a text + buffer, which must be encoded in UTF-8, limited by a byte count. @@ -27,7 +28,7 @@ haystack - string to search + String to search. @@ -35,7 +36,7 @@ bsize - maximum number of bytes to return + Maximum number of bytes to return. @@ -43,7 +44,11 @@ start - starting position in $haystack in bytes + 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. The default is zero. If $start does not point to the first byte of a + UTF-8 character, the start position is moved to the next character + boundary. @@ -66,7 +71,12 @@ ]]> @@ -74,7 +84,7 @@ TODO &example.outputs; @@ -82,7 +92,15 @@ TODO &reftitle.seealso; -TODO + + grapheme_extract + grapheme_substr + + + Unicode Text Segmentation: Grapheme Cluster Boundaries + + + diff --git a/reference/intl/functions/grapheme-stripos.xml b/reference/intl/functions/grapheme-stripos.xml index cdcce4cc3f..3998ce8573 100644 --- a/reference/intl/functions/grapheme-stripos.xml +++ b/reference/intl/functions/grapheme-stripos.xml @@ -1,5 +1,5 @@ - + grapheme_stripos @@ -16,8 +16,6 @@ Find position (in grapheme units) of first occurrence of a case-insensitive string - which character in haystack to start searching. The position - returned is still relative to the beginning of haystack. @@ -29,7 +27,7 @@ haystack - The string to look in + The string to look in. Must be valid UTF-8. @@ -37,7 +35,7 @@ needle - The string to look for + The string to look for. Must be valid UTF-8. @@ -45,7 +43,10 @@ offset - The optional offset parameter allows you to specify + The optional $offset parameter allows you to specify where in haystack to + start searching as an offset in grapheme units (not bytes or characters). If not given, the default is zero. + The position returned is still relative to the beginning of haystack + regardless of the value of $offset. @@ -68,7 +69,13 @@ ]]> @@ -76,7 +83,7 @@ TODO &example.outputs; @@ -84,7 +91,18 @@ TODO &reftitle.seealso; -TODO + + grapheme_stristr + grapheme_strpos + grapheme_strripos + grapheme_strrpos + grapheme_strstr + + + Unicode Text Segmentation: Grapheme Cluster Boundaries + + + diff --git a/reference/intl/functions/grapheme-stristr.xml b/reference/intl/functions/grapheme-stristr.xml index 4b15b3b562..3361ccb08e 100644 --- a/reference/intl/functions/grapheme-stristr.xml +++ b/reference/intl/functions/grapheme-stristr.xml @@ -1,5 +1,5 @@ - + grapheme_stristr @@ -16,7 +16,6 @@ Returns part of haystack string from the first occurrence of case-insensitive needle to the end of haystack. - haystack before the first occurence of the needle. @@ -28,7 +27,7 @@ haystack - The input string. + The input string. Must be valid UTF-8. @@ -36,7 +35,7 @@ needle - The string to look for. + The string to look for. Must be valid UTF-8. @@ -45,6 +44,7 @@ If TRUE (the default is FALSE), grapheme_strstr() returns the part of the + haystack before the first occurence of the needle. @@ -56,7 +56,7 @@ &reftitle.returnvalues; - Returns the portion of string, or FALSE if needle is not found. + Returns the portion of $haystack, or FALSE if $needle is not found. @@ -67,7 +67,13 @@ ]]> @@ -75,7 +81,7 @@ TODO &example.outputs; @@ -83,7 +89,18 @@ TODO &reftitle.seealso; -TODO + + grapheme_stripos + grapheme_strpos + grapheme_strripos + grapheme_strrpos + grapheme_strstr + + + Unicode Text Segmentation: Grapheme Cluster Boundaries + + + diff --git a/reference/intl/functions/grapheme-strlen.xml b/reference/intl/functions/grapheme-strlen.xml index 96b5c87d56..4475a1697b 100644 --- a/reference/intl/functions/grapheme-strlen.xml +++ b/reference/intl/functions/grapheme-strlen.xml @@ -1,5 +1,5 @@ - + grapheme_strlen @@ -13,7 +13,7 @@ stringinput - Get string length in grapheme units + Get string length in grapheme units (not bytes or characters) @@ -25,7 +25,7 @@ input - The string being measured for length. + The string being measured for length. It must be a valid UTF-8 string. @@ -48,7 +48,12 @@ ]]> @@ -56,7 +61,7 @@ TODO &example.outputs; @@ -64,7 +69,13 @@ TODO &reftitle.seealso; -TODO + + + + Unicode Text Segmentation: Grapheme Cluster Boundaries + + + diff --git a/reference/intl/functions/grapheme-strpos.xml b/reference/intl/functions/grapheme-strpos.xml index 4ef02eb287..eb18309386 100644 --- a/reference/intl/functions/grapheme-strpos.xml +++ b/reference/intl/functions/grapheme-strpos.xml @@ -1,5 +1,5 @@ - + grapheme_strpos @@ -16,8 +16,6 @@ Find position (in grapheme units) of first occurrence of a string - which character in haystack to start searching. The position - returned is still relative to the beginning of haystack. @@ -29,7 +27,7 @@ haystack - The string to look in + The string to look in. Must be valid UTF-8. @@ -37,7 +35,7 @@ needle - The string to look for + The string to look for. Must be valid UTF-8. @@ -45,7 +43,10 @@ offset - The optional offset parameter allows you to specify + The optional $offset parameter allows you to specify where in $haystack to + start searching as an offset in grapheme units (not bytes or characters). If not given, the default is zero. + The position returned is still relative to the beginning of haystack + regardless of the value of $offset. @@ -68,7 +69,12 @@ ]]> @@ -76,7 +82,7 @@ TODO &example.outputs; @@ -84,7 +90,18 @@ TODO &reftitle.seealso; -TODO + + grapheme_stripos + grapheme_stristr + grapheme_strripos + grapheme_strrpos + grapheme_strstr + + + Unicode Text Segmentation: Grapheme Cluster Boundaries + + + diff --git a/reference/intl/functions/grapheme-strripos.xml b/reference/intl/functions/grapheme-strripos.xml index 546f69f42d..3947e0aa8d 100644 --- a/reference/intl/functions/grapheme-strripos.xml +++ b/reference/intl/functions/grapheme-strripos.xml @@ -1,5 +1,5 @@ - + grapheme_strripos @@ -16,8 +16,6 @@ Find position (in grapheme units) of last occurrence of a case-insensitive string - which character in haystack to start searching. The position - returned is still relative to the beginning of haystack. @@ -29,7 +27,7 @@ haystack - The string to look in + The string to look in. Must be valid UTF-8. @@ -37,7 +35,7 @@ needle - The string to look for + The string to look for. Must be valid UTF-8. @@ -45,7 +43,10 @@ offset - The optional offset parameter allows you to specify + The optional $offset parameter allows you to specify where in $haystack to + start searching as an offset in grapheme units (not bytes or characters). If not given, the default is zero. + The position returned is still relative to the beginning of haystack + regardless of the value of $offset. @@ -68,7 +69,13 @@ ]]> @@ -76,7 +83,7 @@ TODO &example.outputs; @@ -84,7 +91,18 @@ TODO &reftitle.seealso; -TODO + + grapheme_stripos + grapheme_stristr + grapheme_strpos + grapheme_strrpos + grapheme_strstr + + + Unicode Text Segmentation: Grapheme Cluster Boundaries + + + diff --git a/reference/intl/functions/grapheme-strrpos.xml b/reference/intl/functions/grapheme-strrpos.xml index 3c0a69abf9..e0677c5850 100644 --- a/reference/intl/functions/grapheme-strrpos.xml +++ b/reference/intl/functions/grapheme-strrpos.xml @@ -1,5 +1,5 @@ - + grapheme_strrpos @@ -16,8 +16,6 @@ Find position (in grapheme units) of last occurrence of a string - which character in haystack to start searching. The position - returned is still relative to the beginning of haystack. @@ -29,7 +27,7 @@ haystack - The string to look in + The string to look in. Must be valid UTF-8. @@ -37,7 +35,7 @@ needle - The string to look for + The string to look for. Must be valid UTF-8. @@ -45,7 +43,10 @@ offset - The optional offset parameter allows you to specify + The optional $offset parameter allows you to specify where in $haystack to + start searching as an offset in grapheme units (not bytes or characters). If not given, the default is zero. + The position returned is still relative to the beginning of haystack + regardless of the value of $offset. @@ -68,7 +69,12 @@ ]]> @@ -76,7 +82,7 @@ TODO &example.outputs; @@ -84,7 +90,18 @@ TODO &reftitle.seealso; -TODO + + grapheme_stripos + grapheme_stristr + grapheme_strpos + grapheme_strripos + grapheme_strstr + + + Unicode Text Segmentation: Grapheme Cluster Boundaries + + + diff --git a/reference/intl/functions/grapheme-strstr.xml b/reference/intl/functions/grapheme-strstr.xml index c859d489f3..d5c43471f7 100644 --- a/reference/intl/functions/grapheme-strstr.xml +++ b/reference/intl/functions/grapheme-strstr.xml @@ -1,5 +1,5 @@ - + grapheme_strstr @@ -16,7 +16,6 @@ Returns part of haystack string from the first occurrence of needle to the end of haystack. - haystack before the first occurence of the needle. @@ -28,7 +27,7 @@ haystack - The input string. + The input string. Must be valid UTF-8. @@ -36,7 +35,7 @@ needle - The string to look for. + The string to look for. Must be valid UTF-8. @@ -45,6 +44,7 @@ If TRUE (the default is FALSE), grapheme_strstr() returns the part of the + haystack before the first occurence of the needle. @@ -67,7 +67,12 @@ ]]> @@ -75,7 +80,7 @@ TODO &example.outputs; @@ -83,7 +88,18 @@ TODO &reftitle.seealso; -TODO + + grapheme_stristr + grapheme_stripos + grapheme_strpos + grapheme_strripos + grapheme_strrpos + + + Unicode Text Segmentation: Grapheme Cluster Boundaries + + + diff --git a/reference/intl/functions/grapheme-substr.xml b/reference/intl/functions/grapheme-substr.xml index 82b22b96c7..ba6d61a7b6 100644 --- a/reference/intl/functions/grapheme-substr.xml +++ b/reference/intl/functions/grapheme-substr.xml @@ -1,5 +1,5 @@ - + grapheme_substr @@ -16,16 +16,7 @@ Return part of a string - start'th position in string, counting from zero. If start is negative, - the returned string will start at the start'th character from the - end of string. - at most length characters beginning from start (depending on the - length of string). If string is less than or equal to start characters - long, FALSE will be returned. If length is given and is negative, then - that many characters will be omitted from the end of string (after the - start position has been calculated when a start is negative). If start - denotes a position beyond this truncation, an empty string will be returned. - + @@ -36,7 +27,7 @@ string - The input string. + The input string. Must be valid UTF-8. @@ -44,7 +35,11 @@ start - If start is non-negative, the returned string will start at the + Start position in default grapheme units. + If $start is non-negative, the returned string will start at the + $start'th position in $string, counting from zero. If $start is negative, + the returned string will start at the $start'th character from the + end of string. @@ -52,7 +47,14 @@ length - If length is given and is positive, the string returned will contain + Length in grapheme units. + If $length is given and is positive, the string returned will contain + at most $length characters beginning from $start (depending on the + length of string). If $string is less than or equal to $start characters + long, FALSE will be returned. If $length is given and is negative, then + that many characters will be omitted from the end of string (after the + start position has been calculated when a start is negative). If $start + denotes a position beyond this truncation, an empty string will be returned. @@ -64,7 +66,7 @@ &reftitle.returnvalues; - Returns the extracted part of string. + Returns the extracted part of $string. @@ -75,7 +77,11 @@ ]]> @@ -83,7 +89,7 @@ TODO &example.outputs; @@ -91,7 +97,15 @@ TODO &reftitle.seealso; -TODO + + grapheme_extract + grapheme_extractB + + + Unicode Text Segmentation: Grapheme Cluster Boundaries + + +