[PHP 8.4] Add manual for grapheme_str_split function

Author: youkidearitai

reference/intl/grapheme/grapheme-str-split.xml

@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<refentry xml:id="function.grapheme-str-split" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>grapheme_str_split</refname>
+  <refpurpose>Given a grapheme cluster string, which must be encoded in UTF-8</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <para>&style.procedural;</para>
+  <methodsynopsis>
+   <type class="union"><type>array</type><type>false</type></type><methodname>grapheme_str_split</methodname>
+   <methodparam><type>string</type><parameter>string</parameter></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>length</parameter><initializer>1</initializer></methodparam>
+  </methodsynopsis>
+  <para>
+   This function will return an array of strings, it is a version of <function>str_split</function> with support for grapheme cluster byte characters.
+   If the <parameter>length</parameter> parameter is specified, the string is broken down into chunks of the specified length in grapheme clusters (not bytes).
+  </para> 
+  </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>string</parameter></term>
+     <listitem>
+      <para>
+       The &string; to split into grapheme clusters or chunks. Must be valid UTF-8.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>length</parameter></term>
+     <listitem>
+      <para>
+        If specified, each element of the returned array will be composed of grapheme clusters instead of a single grapheme cluster.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>str_split</function></member>
+    <member><function>mb_str_split</function></member>
+     <member>
+      <link xlink:href="&uri.unicode.graphemes;">
+       Unicode Text Segmentation: Grapheme Cluster Boundaries
+      </link>
+     </member>
+   </simplelist>
+  </para>
+ </refsect1>
+</refentry>
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->

reference/intl/versions.xml

@@ -392,6 +392,7 @@
  <function name="grapheme_strstr" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8, PECL intl &gt;= 1.0.0"/>
  <function name="grapheme_stristr" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8, PECL intl &gt;= 1.0.0"/>
  <function name="grapheme_extract" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8, PECL intl &gt;= 1.0.0"/>
+ <function name="grapheme_str_split" from="PHP 8 &gt;= 8.4.0"/>
  <function name="intl_get_error_code" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8, PECL intl &gt;= 1.0.0"/>
  <function name="intl_get_error_message" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8, PECL intl &gt;= 1.0.0"/>
  <function name="intl_is_failure" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8, PECL intl &gt;= 1.0.0"/>

reference/mbstring/functions/mb-str-split.xml

@@ -89,6 +89,7 @@
   <para>
    <simplelist>
     <member><function>str_split</function></member>
+    <member><function>grapheme_str_split</function></member>
    </simplelist>
   </para>
  </refsect1>

reference/strings/functions/str-split.xml

@@ -151,6 +151,7 @@ Array
    <para>
     <function>str_split</function> will split into bytes, rather than characters when dealing with a multi-byte encoded string.
     Use <function>mb_str_split</function> to split the string into code points. 
+    Use <function>grapheme_str_split</function> to split the string into grapheme clusetrs. 
    </para>
   </note>
  </refsect1>
@@ -160,6 +161,7 @@ Array
   <para>
    <simplelist>
     <member><function>mb_str_split</function></member>
+    <member><function>grapheme_str_split</function></member>
     <member><function>chunk_split</function></member>
     <member><function>preg_split</function></member>
     <member><function>explode</function></member>