-
Notifications
You must be signed in to change notification settings - Fork 59
Expand file tree
/
Copy pathmb-convert-encoding.xml
More file actions
203 lines (192 loc) · 6.57 KB
/
mb-convert-encoding.xml
File metadata and controls
203 lines (192 loc) · 6.57 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
203
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c1f37a6c270aadbbb3da56a3973ffd62197adf2b Maintainer: PhilDaiguille 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 una cadena de un codificación de caracteres a otra</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>
Convierte la <parameter>string</parameter> desde <parameter>from_encoding</parameter>,
o la codificación interna actual, a <parameter>to_encoding</parameter>.
Opcionalmente desde <parameter>from_encoding</parameter>.
Si <parameter>string</parameter> es un &array;, todos sus valores &string;
serán convertidos recursivamente.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem>
<para>
La &string; o &array; a convertir.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>to_encoding</parameter></term>
<listitem>
<para>
La codificación deseada del resultado.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>from_encoding</parameter></term>
<listitem>
<para>
La codificación actual utilizada para interpretar la <parameter>string</parameter>.
Múltiples codificaciones pueden ser especificadas en forma de array (&array;) o lista separada por comas.
En este caso, la codificación correcta será adivinada utilizando el
mismo algoritmo que <function>mb_detect_encoding</function>.
</para>
<para>
Si <parameter>from_encoding</parameter> es omitido o &null;, el
parámetro <link linkend="ini.mbstring.internal-encoding">mbstring.internal_encoding</link>
será utilizado si está definido, de lo contrario el parámetro <link linkend="ini.default-charset">default_charset</link> será utilizado.
</para>
<para>
Ver <link linkend="mbstring.supported-encodings">codificaciones soportadas</link>
para los valores válidos de <parameter>to_encoding</parameter>
y <parameter>from_encoding</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
La &string; o &array; codificado en caso de éxito, &return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
A partir de PHP 8.0.0, una <classname>ValueError</classname> es lanzada si la
valor de <parameter>to_encoding</parameter> o
<parameter>from_encoding</parameter> es una codificación inválida.
Anterior a PHP 8.0.0, una <constant>E_WARNING</constant> era emitida en su lugar.
</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> ya no devolverá
las siguientes codificaciones no textuales:
<literal>"Base64"</literal>, <literal>"QPrint"</literal>,
<literal>"UUencode"</literal>, <literal>"HTML entities"</literal>,
<literal>"7 bit"</literal> y <literal>"8 bit"</literal>.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
<function>mb_convert_encoding</function> lanzará ahora una
<classname>ValueError</classname> cuando
<parameter>to_encoding</parameter> es pasado una codificación inválida.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
<function>mb_convert_encoding</function> lanzará ahora una
<classname>ValueError</classname> cuando
<parameter>from_encoding</parameter> es pasado una codificación inválida.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>from_encoding</parameter> ahora es nullable.
</entry>
</row>
<row>
<entry>7.2.0</entry>
<entry>
Esta función ahora acepta un &array; como
<parameter>string</parameter>.
Anteriormente, solo las &string; eran soportadas.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Ejemplo con <function>mb_convert_encoding</function></title>
<programlisting role="php" annotations="non-interactive">
<![CDATA[
<?php
/* Convierte la codificación interna a SJIS */
$str = mb_convert_encoding($str, "SJIS");
/* Convierte EUC-JP a UTF-7 */
$str = mb_convert_encoding($str, "UTF-7", "EUC-JP");
/* Detecta automáticamente una codificación entre JIS, eucjp-win o sjis-win,
Luego convierte a UCS-2LE */
$str = mb_convert_encoding($str, "UCS-2LE", "JIS, eucjp-win, sjis-win");
/* Si mbstring.language es "Japanese", "auto" es extendido a "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
-->