cvs: phpdoc /en/reference/strings/functions convert-uudecode.xml convert-uuencode.xml /en/reference/url/functions base64-encode.xml

nlopess Tue Jul 6 08:00:31 2004 EDT Modified files: /phpdoc/en/reference/url/functions base64-encode.xml /phpdoc/en/reference/strings/functions convert-uudecode.xml convert-uuencode.xml Log: adding docs for convert_uuencode and decode http://cvs.php.net/diff.php/phpdoc/en/reference/url/functions/base64-encode.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/url/functions/base64-encode.xml diff -u phpdoc/en/reference/url/functions/base64-encode.xml:1.5 phpdoc/en/reference/url/functions/base64-encode.xml:1.6 --- phpdoc/en/reference/url/functions/base64-encode.xml:1.5 Sat Aug 16 10:59:57 2003 +++ phpdoc/en/reference/url/functions/base64-encode.xml Tue Jul 6 08:00:30 2004 @@ -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 @@ <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> http://cvs.php.net/diff.php/phpdoc/en/reference/strings/functions/convert-uudecode.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/strings/functions/convert-uudecode.xml diff -u phpdoc/en/reference/strings/functions/convert-uudecode.xml:1.2 phpdoc/en/reference/strings/functions/convert-uudecode.xml:1.3 --- phpdoc/en/reference/strings/functions/convert-uudecode.xml:1.2 Sat May 1 19:10:35 2004 +++ phpdoc/en/reference/strings/functions/convert-uudecode.xml Tue Jul 6 08:00:31 2004 @@ -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> http://cvs.php.net/diff.php/phpdoc/en/reference/strings/functions/convert-uuencode.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/strings/functions/convert-uuencode.xml diff -u phpdoc/en/reference/strings/functions/convert-uuencode.xml:1.2 phpdoc/en/reference/strings/functions/convert-uuencode.xml:1.3 --- phpdoc/en/reference/strings/functions/convert-uuencode.xml:1.2 Sat May 1 19:10:35 2004 +++ phpdoc/en/reference/strings/functions/convert-uuencode.xml Tue Jul 6 08:00:31 2004 @@ -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>