php-doc-en/reference/strings/functions/convert-uuencode.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.convert-uuencode" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>convert_uuencode</refname>
  <refpurpose>Uuencode a string</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>convert_uuencode</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>convert_uuencode</function> encodes a string using the uuencode
   algorithm.
  </para>
  <para>
   Uuencode translates all strings (including binary data) into printable
   characters, making them safe for network transmissions. Uuencoded data is
   about 35% larger than the original.
  </para>
  <note>
   <simpara>
    <function>convert_uuencode</function> neither produces the <literal>begin</literal>
    nor the <literal>end</literal> line, which are part of uuencoded <emphasis>files</emphasis>.
   </simpara>
  </note> 
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       The data to be encoded.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the uuencoded data.
  </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.0.0</entry>
      <entry>
       Prior to this version, trying to convert an empty string returned &false;
       for no particular reason.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>convert_uuencode</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$some_string = "test\ntext text\r\n";

echo convert_uuencode($some_string);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
0=&5S=`IT97AT('1E>'0-"@``
`
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>convert_uudecode</function></member>
    <member><function>base64_encode</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
-->