-
Notifications
You must be signed in to change notification settings - Fork 164
Expand file tree
/
Copy pathmb-convert-encoding.xml
More file actions
202 lines (191 loc) · 6.51 KB
/
mb-convert-encoding.xml
File metadata and controls
202 lines (191 loc) · 6.51 KB
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c1f37a6c270aadbbb3da56a3973ffd62197adf2b Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.mb-convert-encoding" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mb_convert_encoding</refname>
<refpurpose>Convertir une chaîne d'un codage de caractères à un autre</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>string</type><type>false</type></type><methodname>mb_convert_encoding</methodname>
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>string</parameter></methodparam>
<methodparam><type>string</type><parameter>to_encoding</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>array</type><type>string</type><type>null</type></type><parameter>from_encoding</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Convertit la <parameter>string</parameter> à partir de <parameter>from_encoding</parameter>,
ou l'encodage interne actuel, en <parameter>to_encoding</parameter>.
Si <parameter>string</parameter> est un &array;, toutes ses valeurs &string;
seront converties récursivement.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem>
<para>
La &string; ou &array; à convertir.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>to_encoding</parameter></term>
<listitem>
<para>
L'encodage désiré du résultat.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>from_encoding</parameter></term>
<listitem>
<para>
L'encodage actuel utilisé pour interpréter la <parameter>string</parameter>.
Plusieurs encodages peuvent être spécifiés sous forme de tableau (&array;) ou de liste séparée par des virgules.
Dans ce cas, l'encodage correct sera deviné en utilisant le
même algorithme que <function>mb_detect_encoding</function>.
</para>
<para>
Si <parameter>from_encoding</parameter> est omis ou &null;, le
paramètre <link linkend="ini.mbstring.internal-encoding">mbstring.internal_encoding</link>
sera utilisé s'il est défini, sinon le paramètre <link linkend="ini.default-charset">default_charset</link> sera utilisé.
</para>
<para>
Voir <link linkend="mbstring.supported-encodings">encodages pris en charge</link>
pour les valeurs valides de <parameter>to_encoding</parameter>
et <parameter>from_encoding</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
La &string; ou &array; encodé en cas de succès, &return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
À partir de PHP 8.0.0, une <classname>ValueError</classname> est lancée si la
valeur de <parameter>to_encoding</parameter> ou
<parameter>from_encoding</parameter> est un encodage invalide.
Antérieur à PHP 8.0.0, une <constant>E_WARNING</constant> était émise à la place.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.2.0</entry>
<entry>
<function>mb_convert_encoding</function> ne renverra plus
les encodages non textuels suivants :
<literal>"Base64"</literal>, <literal>"QPrint"</literal>,
<literal>"UUencode"</literal>, <literal>"HTML entities"</literal>,
<literal>"7 bit"</literal> et <literal>"8 bit"</literal>.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
<function>mb_convert_encoding</function> lancera désormais une
<classname>ValueError</classname> quand
un encodage invalide est passé à <parameter>to_encoding</parameter>.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
<function>mb_convert_encoding</function> lancera désormais une
<classname>ValueError</classname> quand
un encodage invalide est passé à <parameter>from_encoding</parameter>.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>from_encoding</parameter> est désormais nullable.
</entry>
</row>
<row>
<entry>7.2.0</entry>
<entry>
Cette fonction accepte désormais un &array; en tant que
<parameter>string</parameter>.
Auparavant, seulement les &string; étaient supportées.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple avec <function>mb_convert_encoding</function></title>
<programlisting role="php" annotations="non-interactive">
<![CDATA[
<?php
/* Convertit l'encodage interne vers SJIS */
$str = mb_convert_encoding($str, "SJIS");
/* Convertit EUC-JP en UTF-7 */
$str = mb_convert_encoding($str, "UTF-7", "EUC-JP");
/* Détecte automatiquement un encodage entre JIS, eucjp-win ou sjis-win,
Puis convertit en UCS-2LE */
$str = mb_convert_encoding($str, "UCS-2LE", "JIS, eucjp-win, sjis-win");
/* Si mbstring.language est "Japanese", "auto" est étendu à "ASCII,JIS,UTF-8,EUC-JP,SJIS" */
$str = mb_convert_encoding($str, "EUC-JP", "auto");
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mb_detect_order</function></member>
<member><methodname>UConverter::transcode</methodname></member>
<member><function>iconv</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
-->