<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.mcrypt.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'function.mcrypt-module-self-test.php',
    1 => 'mcrypt_module_self_test',
    2 => 'This function runs a self test on the specified module',
  ),
  'up' => 
  array (
    0 => 'ref.mcrypt.php',
    1 => 'Mcrypt Functions',
  ),
  'prev' => 
  array (
    0 => 'function.mcrypt-module-open.php',
    1 => 'mcrypt_module_open',
  ),
  'next' => 
  array (
    0 => 'function.mdecrypt-generic.php',
    1 => 'mdecrypt_generic',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/mcrypt/functions/mcrypt-module-self-test.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<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 &gt;= 4.0.2, PHP 5, PHP 7 &lt; 7.2.0, PECL mcrypt &gt;= 1.0.0)</p><p class="refpurpose"><span class="refname">mcrypt_module_self_test</span> &mdash; <span class="dc-title">This function runs a self test on the specified module</span></p>

 </div>
 <div id="function.mcrypt-module-self-test-refsynopsisdiv">
  <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function has been
<em>DEPRECATED</em> as of PHP 7.1.0 and
<em>REMOVED</em> as of PHP 7.2.0. Relying on this function
is highly discouraged.</p></div>
 </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="methodname"><strong>mcrypt_module_self_test</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$algorithm</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$lib_dir</code><span class="initializer"> = ?</span></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="simpara">
   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>
  <dl>
   
    <dt><code class="parameter">algorithm</code></dt>
    <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><code class="parameter">lib_dir</code></dt>
    <dd>
     <span class="simpara">
      The optional <code class="parameter">lib_dir</code> parameter can contain the
      location where the algorithm module is on the system.
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.mcrypt-module-self-test-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="simpara">
   The function returns <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> if the self test succeeds, or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> when it
   fails.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.mcrypt-module-self-test-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="example-1">
   <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">&lt;?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">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>The above example will output:</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">bool(true)
bool(false)</pre>
</div>
   </div>
  </div>
 </div>

</div><?php manual_footer($setup); ?>