reference/strings/functions/convert-uudecode.xml
e095023e408c8cb6378ae16bb6870343a3946919
e095023e408c8cb6378ae16bb6870343a3946919
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.convert-uudecode">
3
+
<refentry xml:id="function.convert-uudecode" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>convert_uudecode</refname>
6
6
<refpurpose>Decode a uuencoded string</refpurpose>
...
...
@@ -9,12 +9,18 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>string</type><methodname>convert_uudecode</methodname>
13
-
<methodparam><type>string</type><parameter>data</parameter></methodparam>
12
+
<type class="union"><type>string</type><type>false</type></type><methodname>convert_uudecode</methodname>
13
+
<methodparam><type>string</type><parameter>string</parameter></methodparam>
14
14
</methodsynopsis>
15
15
<para>
16
16
<function>convert_uudecode</function> decodes a uuencoded string.
17
17
</para>
18
+
<note>
19
+
<simpara>
20
+
<function>convert_uudecode</function> neither accepts the <literal>begin</literal>
21
+
nor the <literal>end</literal> line, which are part of uuencoded <emphasis>files</emphasis>.
22
+
</simpara>
23
+
</note>
18
24
</refsect1>
19
25
20
26
<refsect1 role="parameters">
...
...
@@ -22,7 +28,7 @@
22
28
<para>
23
29
<variablelist>
24
30
<varlistentry>
25
-
<term><parameter>data</parameter></term>
31
+
<term><parameter>string</parameter></term>
26
32
<listitem>
27
33
<para>
28
34
The uuencoded data.
...
...
@@ -48,11 +54,16 @@
48
54
<programlisting role="php">
49
55
<![CDATA[
50
56
<?php
51
-
/* Can you imagine what this will print? :) */
52
57
echo convert_uudecode("+22!L;W9E(%!(4\"$`\n`");
53
58
?>
54
59
]]>
55
60
</programlisting>
61
+
&example.outputs;
62
+
<screen>
63
+
<![CDATA[
64
+
I love PHP!
65
+
]]>
66
+
</screen>
56
67
</example>
57
68
</para>
58
69
</refsect1>
...
...
@@ -67,7 +78,6 @@ echo convert_uudecode("+22!L;W9E(%!(4\"$`\n`");
67
78
</refsect1>
68
79
69
80
</refentry>
70
-
71
81
<!-- Keep this comment at the end of the file
72
82
Local variables:
73
83
mode: sgml
74
84