php-doc-en/reference/url/functions/base64-encode.xml
Philip Olson 521b262238 WS, preparation for the new doc style
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@209052 c90b9560-bf6c-de11-be94-00142212c4b1
2006-03-10 04:54:53 +00:00

75 lines
1.8 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<refentry id="function.base64-encode">
<refnamediv>
<refname>base64_encode</refname>
<refpurpose>Encodes data with MIME base64</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>base64_encode</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
<function>base64_encode</function> returns
<parameter>data</parameter> encoded with base64. This encoding
is designed to make binary data survive transport through
transport layers that are not 8-bit clean, such as mail bodies.
</para>
<para>
Base64-encoded data takes about 33% more space than the original
data.
</para>
<para>
<example>
<title><function>base64_encode</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$str = 'This is an encoded string';
echo base64_encode($str);
?>
]]>
</programlisting>
<para>
This example will produce:
</para>
<screen>
<![CDATA[
VGhpcyBpcyBhbiBlbmNvZGVkIHN0cmluZw==
]]>
</screen>
</example>
</para>
<para>
See also
<function>base64_decode</function>,
<function>chunk_split</function>,
<function>convert_uuencode</function> and
<ulink url="&url.rfc;2045">RFC 2045</ulink> section 6.8.
</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:"../../../../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
-->