<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Gets an array of all supported modes</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mcrypt-list-algorithms.html">mcrypt_list_algorithms</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mcrypt-module-close.html">mcrypt_module_close</a></div>
<div class="up"><a href="ref.mcrypt.html">Mcrypt Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.mcrypt-list-modes" class="refentry">
<div class="refnamediv">
<h1 class="refname">mcrypt_list_modes</h1>
<p class="verinfo">(PHP 4 >= 4.0.2, PHP 5)</p><p class="refpurpose"><span class="refname">mcrypt_list_modes</span> — <span class="dc-title">Gets an array of all supported modes</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.mcrypt-list-modes-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>mcrypt_list_modes</strong></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$lib_dir</code><span class="initializer"> = ini_get("mcrypt.modes_dir")</span></span>
] )</div>
<p class="para rdfs-comment">
Gets the list of all supported modes in the
<em><code class="parameter">lib_dir</code></em> parameter.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.mcrypt-list-modes-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">lib_dir</code></em></span>
<dd>
<p class="para">
Specifies the directory where all modes are located. If not
specified, the value of the <em>mcrypt.modes_dir</em>
<var class="filename">php.ini</var> directive is used.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.mcrypt-list-modes-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an array with all the supported modes.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.mcrypt-list-modes-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-849">
<p><strong>Example #1 <span class="function"><strong>mcrypt_list_modes()</strong></span> Example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /> $modes </span><span style="color: #007700">= </span><span style="color: #0000BB">mcrypt_list_modes</span><span style="color: #007700">();<br /><br /> foreach (</span><span style="color: #0000BB">$modes </span><span style="color: #007700">as </span><span style="color: #0000BB">$mode</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$mode</span><span style="color: #DD0000"> <br />\n"</span><span style="color: #007700">;<br /> }<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>
The example above will produce a list with all supported
algorithms in the default mode directory. If it is not set
with the <em>mcrypt.modes_dir</em> <var class="filename">php.ini</var>
directive, the default directory of mcrypt is used (which
is <var class="filename">/usr/local/lib/libmcrypt</var>).
</p></div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mcrypt-list-algorithms.html">mcrypt_list_algorithms</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mcrypt-module-close.html">mcrypt_module_close</a></div>
<div class="up"><a href="ref.mcrypt.html">Mcrypt Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
