<!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>This function runs a self test on the specified module</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mcrypt-module-open.html">mcrypt_module_open</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mcrypt-ofb.html">mcrypt_ofb</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-module-self-test" class="refentry">
<div class="refnamediv">
<h1 class="refname">mcrypt_module_self_test</h1>
<p class="verinfo">(PHP 4 >= 4.0.2, PHP 5)</p><p class="refpurpose"><span class="refname">mcrypt_module_self_test</span> — <span class="dc-title">This function runs a self test on the specified module</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.mcrypt-module-self-test-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>mcrypt_module_self_test</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$algorithm</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$lib_dir</code></span>
] )</div>
<p class="para rdfs-comment">
This function runs the self test on the algorithm specified.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.mcrypt-module-self-test-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">algorithm</code></em></span>
<dd>
<p class="para">One of the <strong><code>MCRYPT_ciphername</code></strong> constants, or the name of the algorithm as string.</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">lib_dir</code></em></span>
<dd>
<p class="para">
The optional <em><code class="parameter">lib_dir</code></em> parameter can contain the
location where the algorithm module is on the system.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.mcrypt-module-self-test-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The function returns <strong><code>TRUE</code></strong> if the self test succeeds, or <strong><code>FALSE</code></strong> when it
fails.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.mcrypt-module-self-test-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-852">
<p><strong>Example #1 <span class="function"><strong>mcrypt_module_self_test()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">mcrypt_module_self_test</span><span style="color: #007700">(</span><span style="color: #0000BB">MCRYPT_RIJNDAEL_128</span><span style="color: #007700">)) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">mcrypt_module_self_test</span><span style="color: #007700">(</span><span style="color: #0000BB">MCRYPT_BOGUS_CYPHER</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
bool(true)
bool(false)
</pre></div>
</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-module-open.html">mcrypt_module_open</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mcrypt-ofb.html">mcrypt_ofb</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>
