adding docs for convert_uuencode and decode

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@162744 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Nuno Lopes 2004-07-06 12:00:31 +00:00
parent d005e0539b
commit ce4f51db5b
3 changed files with 50 additions and 9 deletions

View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.convert-uudecode">
<refnamediv>
<refname>convert_uudecode</refname>
@ -13,9 +13,25 @@
<type>string</type><methodname>convert_uudecode</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
<function>convert_uudecode</function> decodes a uuencoded string.
</para>
<para>
<example>
<title><function>convert_uudecode</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* Can you imagine what this will print? :) */
echo convert_uudecode("+22!L;W9E(%!(4\"$`\n`");
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>convert_uuencode</function>.
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry id="function.convert-uuencode">
<refnamediv>
<refname>convert_uuencode</refname>
@ -13,9 +13,33 @@
<type>string</type><methodname>convert_uuencode</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
<function>convert_uuencode</function> encodes a string using the uuencode
algorithm.
</para>
<para>
Uuencode translates all strings (including binnary's ones) into printable
characters, making them safe for network transmitions. Uuencoded data is
about 35% larger than the original.
</para>
<para>
<example>
<title><function>convert_uuencode</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$some_string = "test\ntext text\r\n";
&warn.undocumented.func;
echo convert_uuencode($some_string);
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>convert_uudecode</function> and
<function>base64_encode</function>.
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/url.xml, last change in rev 1.2 -->
<refentry id="function.base64-encode">
<refnamediv>
@ -46,7 +46,8 @@ VGhpcyBpcyBhbiBlbmNvZGVkIHN0cmluZw==
<para>
See also
<function>base64_decode</function>,
<function>chunk_split</function> and
<function>chunk_split</function>,
<function>convert_uuencode</function> and
<ulink url="&url.rfc;2045">RFC 2045</ulink> section 6.8.
</para>
</refsect1>