mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
90 lines
2.7 KiB
XML
90 lines
2.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.sodium-bin2base64">
|
|
<refnamediv>
|
|
<refname>sodium_bin2base64</refname>
|
|
<refpurpose>Encodes a raw binary string with base64.</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>sodium_bin2base64</methodname>
|
|
<methodparam><type>string</type><parameter>string</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>id</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Converts a raw binary string into a base64-encoded string. Unlike <function>base64_encode</function>,
|
|
<function>sodium_bin2base64</function> is constant-time (a property that is important for any code that
|
|
touches cryptographic inputs, such as plaintexts or keys) and supports multiple character sets.
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>string</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Raw binary string.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>id</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
<simplelist>
|
|
<member>
|
|
<constant>SODIUM_BASE64_VARIANT_ORIGINAL</constant> for standard (<literal>A-Za-z0-9/\+</literal>)
|
|
Base64 encoding.
|
|
</member>
|
|
<member>
|
|
<constant>SODIUM_BASE64_VARIANT_ORIGINAL_NO_PADDING</constant> for standard (<literal>A-Za-z0-9/\+</literal>)
|
|
Base64 encoding, without <literal>=</literal> padding characters.
|
|
</member>
|
|
<member>
|
|
<constant>SODIUM_BASE64_VARIANT_URLSAFE</constant> for URL-safe (<literal>A-Za-z0-9\-_</literal>) Base64 encoding.
|
|
</member>
|
|
<member>
|
|
<constant>SODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING</constant> for URL-safe (<literal>A-Za-z0-9\-_</literal>)
|
|
Base64 encoding, without <literal>=</literal> padding characters.
|
|
</member>
|
|
</simplelist>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Base64-encoded string.
|
|
</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
|
|
-->
|