reference/iconv/functions/iconv.xml
a223531900823441f82d178ca4e94c0444f24576
...
...
@@ -3,7 +3,7 @@
3
3
<refentry xml:id="function.iconv" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>iconv</refname>
6
-
<refpurpose>Convert string to requested character encoding</refpurpose>
6
+
<refpurpose>Convert a string from one character encoding to another</refpurpose>
7
7
</refnamediv>
8
8
9
9
<refsect1 role="description">
...
...
@@ -15,8 +15,7 @@
15
15
<methodparam><type>string</type><parameter>string</parameter></methodparam>
16
16
</methodsynopsis>
17
17
<para>
18
-
Performs a character set conversion on the string
19
-
<parameter>string</parameter> from <parameter>from_encoding</parameter>
18
+
Converts <parameter>string</parameter> from <parameter>from_encoding</parameter>
20
19
to <parameter>to_encoding</parameter>.
21
20
</para>
22
21
</refsect1>
...
...
@@ -29,7 +28,7 @@
29
28
<term><parameter>from_encoding</parameter></term>
30
29
<listitem>
31
30
<para>
32
-
The input charset.
31
+
The current encoding used to interpret <parameter>string</parameter>.
33
32
</para>
34
33
</listitem>
35
34
</varlistentry>
...
...
@@ -37,14 +36,14 @@
37
36
<term><parameter>to_encoding</parameter></term>
38
37
<listitem>
39
38
<para>
40
-
The output charset.
39
+
The desired encoding of the result.
41
40
</para>
42
41
<para>
43
-
If you append the string <literal>//TRANSLIT</literal> to
44
-
<parameter>to_encoding</parameter> transliteration is activated. This
42
+
If the string <literal>//TRANSLIT</literal> is appended to
43
+
<parameter>to_encoding</parameter>, then transliteration is activated. This
45
44
means that when a character can't be represented in the target charset,
46
-
it can be approximated through one or several similarly looking
47
-
characters. If you append the string <literal>//IGNORE</literal>,
45
+
it may be approximated through one or several similarly looking
46
+
characters. If the string <literal>//IGNORE</literal> is appended,
48
47
characters that cannot be represented in the target charset are silently
49
48
discarded. Otherwise, <constant>E_NOTICE</constant> is generated and the function
50
49
will return &false;.
...
...
@@ -64,7 +63,7 @@
64
63
<term><parameter>string</parameter></term>
65
64
<listitem>
66
65
<para>
67
-
The string to be converted.
66
+
The &string; to be converted.
68
67
</para>
69
68
</listitem>
70
69
</varlistentry>
...
...
@@ -75,7 +74,7 @@
75
74
<refsect1 role="returnvalues">
76
75
&reftitle.returnvalues;
77
76
<para>
78
-
Returns the converted string&return.falseforfailure;.
77
+
Returns the converted string,&return.falseforfailure;.
79
78
</para>
80
79
</refsect1>
81
80

...
...
@@ -111,7 +110,27 @@ Notice: iconv(): Detected an illegal character in input string in .\iconv-exampl
111
110
</para>
112
111
</refsect1>
113
112

113
+
<refsect1 role="notes">
114
+
&reftitle.notes;
115
+
<note>
116
+
<para>
117
+
The character encodings and options available depend on the installed implementation
118
+
of iconv. If the argument to <parameter>from_encoding</parameter>
119
+
or <parameter>to_encoding</parameter> is not supported on the current system, &false;
120
+
will be returned.
121
+
</para>
122
+
</note>
123
+
</refsect1>
114
124

125
+
<refsect1 role="seealso">
126
+
&reftitle.seealso;
127
+
<para>
128
+
<simplelist>
129
+
<member><function>mb_convert_encoding</function></member>
130
+
<member><methodname>UConverter::transcode</methodname></member>
131
+
</simplelist>
132
+
</para>
133
+
</refsect1>
115
134

116
135
</refentry>
117
136
<!-- Keep this comment at the end of the file
118
137