mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 10:28:54 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
92 lines
2.4 KiB
XML
92 lines
2.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.mcrypt-list-modes" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>mcrypt_list_modes</refname>
|
|
<refpurpose>Get an array of all supported modes</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>mcrypt_list_modes</methodname>
|
|
<methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter><initializer>ini_get("mcrypt.modes_dir")</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Gets the list of all supported modes in the
|
|
<parameter>lib_dir</parameter> parameter.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>lib_dir</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies the directory where all modes are located. If not
|
|
specifies, the value of the <literal>mcrypt.modes_dir</literal>
|
|
&php.ini; directive is used.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns an array with all the supported modes.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>mcrypt_list_modes</function> Example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$modes = mcrypt_list_modes();
|
|
|
|
foreach ($modes as $mode) {
|
|
echo "$mode <br />\n";
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
<para>
|
|
The above example will produce a list with all supported
|
|
algorithms in the default mode directory. If it is not set
|
|
with the ini directive mcrypt.modes_dir, the default directory
|
|
of mcrypt is used (which is <filename>/usr/local/lib/libmcrypt</filename>).
|
|
</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:"~/.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
|
|
-->
|