[PHP 8.4] grapheme_str_split関数の追加 (#168)

Author: youkidearitai

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

@@ -0,0 +1,94 @@
+<?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>書記素クラスターを受け取り、文字の配列を返す</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <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>
+  <simpara>
+   この関数は文字の配列を返します。
+   これは <function>str_split</function>
+   に書記素クラスターのサポートを追加したものです。
+   <parameter>length</parameter> を指定すると、文字列は指定された数の
+   書記素クラスターに分割されます。
+  </simpara>
+  </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>string</parameter></term>
+    <listitem>
+     <para>
+      書記素クラスターまたはチャンクに分割する<type>string</type>。
+      <parameter>string</parameter> はUTF-8でなければなりません。
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>length</parameter></term>
+    <listitem>
+     <para>
+      配列の各要素が <parameter>length</parameter> 書記素クラスターで構成されます。
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <simpara>
+   <function>grapheme_str_split</function> は文字列の配列を返します。 &return.falseforfailure;。
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <simpara>
+   <parameter>length</parameter> が <literal>1</literal> 未満のとき、
+   <classname>ValueError</classname> がスローされます。
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <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>
+ </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
+-->