-
Notifications
You must be signed in to change notification settings - Fork 56
/
iconv-substr.xml
177 lines (171 loc) · 6.05 KB
/
iconv-substr.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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: ab9a7d2e3dfa9224186abcbd7a43b3af08d1bfdb Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.iconv-substr" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>iconv_substr</refname>
<refpurpose>文字列の一部を切り出す</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>iconv_substr</methodname>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
文字列 <parameter>string</parameter> の、
<parameter>offset</parameter> と <parameter>length</parameter>
で指定された一部を返します。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem>
<para>
元の文字列。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
<parameter>offset</parameter> が負でない場合、
<function>iconv_substr</function> は
<parameter>string</parameter> の <parameter>offset</parameter>
番目の文字（ゼロから数えて）から切り出します。
</para>
<para>
<parameter>offset</parameter> が負の場合、
<function>iconv_substr</function> は
<parameter>string</parameter> の最後から数えて
<parameter>offset</parameter> 番目の文字から切り出します。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
<parameter>length</parameter> が指定され、かつ正である場合、
返される文字列は <parameter>offset</parameter>
から数えて最大 <parameter>length</parameter> 文字数分となります
(<parameter>string</parameter> の長さに依存します)。
</para>
<para>
もし負の <parameter>length</parameter> が渡された場合に
<function>iconv_substr</function> が切り出す文字列は、
<parameter>string</parameter> の <parameter>offset</parameter>
番目の文字からはじまり、文字列の最後から数えて
<parameter>length</parameter> 文字分戻ったところまでとなります。
<parameter>offset</parameter> も負の場合、開始位置は
上で説明した方式で計算されます。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
<para>
<parameter>encoding</parameter> が指定されなかった場合、もしくは &null; の場合、文字セットは
ini 設定 <link linkend="iconv.configuration">iconv.internal_encoding</link>
で定義された値とみなされます。
</para>
<para>
<parameter>offset</parameter> や <parameter>length</parameter>
のパラメータは、常に <parameter>charset</parameter> で定義された
文字セットにおける文字数と判断されることに注意してください。
一方、<function>substr</function> の場合はこれらの値を常に
バイト数として判断します。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
文字列 <parameter>string</parameter> の、
<parameter>offset</parameter> と <parameter>length</parameter>
で指定された一部を返します。
</para>
<para>
もし <parameter>string</parameter> が <parameter>offset</parameter>
の文字列長より短い場合は、&false; が返されます。
<parameter>string</parameter> が
<parameter>offset</parameter> の文字数に等しい場合、
空文字列が返されます。
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>length</parameter> と <parameter>encoding</parameter> は、nullable になりました。
</entry>
</row>
<row>
<entry>7.0.11</entry>
<entry>
<parameter>string</parameter> が
<parameter>offset</parameter> の文字数に等しい場合、
空文字列が返されます。
これより前のバージョンでは、この場合 &false; が返されていました。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>substr</function></member>
<member><function>mb_substr</function></member>
<member><function>mb_strcut</function></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
-->