php-doc-en/reference/mcrypt/functions/mcrypt-list-algorithms.xml
Derick Rethans baf0dab17e - Overhaul of the mcrypt docs, including new examples, corrected entries and
newly documented functions


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@82020 c90b9560-bf6c-de11-be94-00142212c4b1
2002-05-12 21:00:20 +00:00

67 lines
2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.7 -->
<refentry id="function.mcrypt-list-algorithms">
<refnamediv>
<refname>mcrypt_list_algorithms</refname>
<refpurpose>Get an array of all supported ciphers</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>mcrypt_list_algorithms</methodname>
<methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter></methodparam>
</methodsynopsis>
<para>
<function>mcrypt_list_algorithms</function> is used to get an
array of all supported algorithms in the <parameter>lib_dir</parameter> parameter.
</para>
<para>
<function>mcrypt_list_algorithms</function> takes an optional
<parameter>lib_dir</parameter> parameter which specifies the directory
where all algorithms are located. If not specifies, the value of the
mcrypt.algorithms_dir &php.ini; directive is used.
</para>
<para>
<example>
<title><function>mcrypt_list_algorithms</function> Example</title>
<programlisting role="php">
<![CDATA[
<?php
$algorithms = mcrypt_list_algorithms ("/usr/local/lib/libmcrypt");
foreach ($algorithms as $cipher) {
echo "$cipher<br />\n";
}
?>
]]>
</programlisting>
<para>
The above example will produce a list with all supported
algorithms in the "/usr/local/lib/libmcrypt" directory.
</para>
</example>
</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
-->