php-doc-en/reference/mcrypt/functions/mcrypt-list-algorithms.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.mcrypt-list-algorithms" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mcrypt_list_algorithms</refname>
  <refpurpose>Get an array of all supported ciphers</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>mcrypt_list_algorithms</methodname>
   <methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter><initializer>ini_get("mcrypt.algorithms_dir")</initializer></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>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <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
-->