-
Notifications
You must be signed in to change notification settings - Fork 56
/
idn-to-ascii.xml
165 lines (158 loc) · 5.16 KB
/
idn-to-ascii.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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b548fc8e5592b577d29aabf9cf2e79d5385ae549 Maintainer: mumumu Status: ready -->
<refentry xml:id="function.idn-to-ascii" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>idn_to_ascii</refname>
<refpurpose>ドメイン名をIDNAのASCII形式に変換する</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.procedural;</para>
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>idn_to_ascii</methodname>
<methodparam><type>string</type><parameter>domain</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>IDNA_DEFAULT</constant></initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>variant</parameter><initializer><constant>INTL_IDNA_VARIANT_UTS46</constant></initializer></methodparam>
<methodparam choice="opt"><type>array</type><parameter role="reference">idna_info</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Unicode のドメイン名を、IDNAが定めたASCII形式に変換します。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>domain</parameter></term>
<listitem>
<para>
変換するドメイン名。UTF-8 にエンコードされている必要があります。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
変換オプション - IDNA_ ではじまる定数
(IDNA_ERROR_* 定数を除く) の組み合わせです。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>variant</parameter></term>
<listitem>
<para>
IDNA 2003 の場合は <constant>INTL_IDNA_VARIANT_2003</constant> (PHP 7.2.0 以降は非推奨)、あるいは
UTS #46 の場合は <constant>INTL_IDNA_VARIANT_UTS46</constant> (ICU 4.6 以降のみ利用可能)。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>idna_info</parameter></term>
<listitem>
<para>
このパラメータを使うのは、<parameter>variant</parameter> が
<constant>INTL_IDNA_VARIANT_UTS46</constant> の場合だけです。
このとき、このパラメータには <literal>'result'</literal>、
<literal>'isTransitionalDifferent'</literal>、そして
<literal>'errors'</literal> の三つのキーを含む配列が入ります。
<literal>'result'</literal> にはおそらく不正だと考えられる変換結果、
<literal>'isTransitionalDifferent'</literal> には
UTS #46 の非移行的な機能を使って結果を変更したかどうかをあらわす boolean 値、そして
<literal>'errors'</literal> はエラー定数 IDNA_ERROR_*
のビットセットを表します。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
IDNA のASCII形式でエンコードされたドメイン名。&return.falseforfailure;
</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>7.4.0</entry>
<entry>
<parameter>variant</parameter> のデフォルト値が
<constant>INTL_IDNA_VARIANT_UTS46</constant> となり、
その代わりに <constant>INTL_IDNA_VARIANT_2003</constant> は非推奨となりました。
</entry>
</row>
<row>
<entry>7.2.0</entry>
<entry>
<constant>INTL_IDNA_VARIANT_2003</constant> は非推奨です。代わりに
<constant>INTL_IDNA_VARIANT_UTS46</constant> を使用してください。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>idn_to_ascii</function> の例</title>
<programlisting role="php">
<![CDATA[
<?php
echo idn_to_ascii('tast.de');
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
xn--tst-qla.de
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>idn_to_utf8</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
-->