-
Notifications
You must be signed in to change notification settings - Fork 56
/
grapheme-extract.xml
180 lines (170 loc) · 5.95 KB
/
grapheme-extract.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 2245ff665ae4b3037728ee52c247b409ad75de35 Maintainer: takagi Status: ready -->
<refentry xml:id="function.grapheme-extract" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>grapheme_extract</refname>
<refpurpose>デフォルトの書記素クラスタシーケンスをテキストバッファから取り出す関数。
テキストは UTF-8 でエンコードされている必要があります</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.procedural;</para>
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>grapheme_extract</methodname>
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>int</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>type</parameter><initializer><constant>GRAPHEME_EXTR_COUNT</constant></initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter role="reference">next</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
デフォルトの書記素クラスタシーケンスをテキストバッファから取り出す関数です。
テキストは UTF-8 でエンコードされている必要があります。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>haystack</parameter></term>
<listitem>
<para>
検索する文字列。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<para>
返す項目 (<parameter>type</parameter> に基づく) の最大数。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem>
<para>
<parameter>size</parameter> パラメータの単位の形式を指定します。
</para>
<para>
<simplelist>
<member>GRAPHEME_EXTR_COUNT (デフォルト) - <parameter>size</parameter> は、
抽出するデフォルト書記素クラスタの数です。</member>
<member>GRAPHEME_EXTR_MAXBYTES - <parameter>size</parameter> は、返すバイト数の最大値です。</member>
<member>GRAPHEME_EXTR_MAXCHARS - <parameter>size</parameter> は、返す UTF-8 文字数の最大値です。</member>
</simplelist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
<parameter>haystack</parameter> 内での開始位置をバイト数で指定します。
指定する場合は、0 から <parameter>haystack</parameter> のバイト数までの値でなければなりません。
負の値を指定すると、<parameter>haystack</parameter> の末尾からバイト数を数えます。
<parameter>offset</parameter> が指す位置が UTF-8 文字の先頭バイトでない場合は、
その次の文字の先頭から開始します。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>next</parameter></term>
<listitem>
<para>
次の開始位置への参照が設定されます。
この関数をコールすると、文字列の最後の部分の先頭バイトを指すことになります。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
オフセット <parameter>offset</parameter> から始まり、
指定した <parameter>size</parameter> と <parameter>type</parameter> を満たす、
デフォルトの書記素クラスタバウンダリで終わる文字列を返します。
&return.falseforfailure;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>7.1.0</entry>
<entry>
負の <parameter>offset</parameter> をサポートするようになりました。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>grapheme_extract</function> の例</title>
<programlisting role="php">
<![CDATA[
<?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));
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
o%CC%88
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>grapheme_substr</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
-->