php-doc-en/reference/mcrypt/functions/mcrypt-module-self-test.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.7 -->
  <refentry id="function.mcrypt-module-self-test">
   <refnamediv>
    <refname>mcrypt_module_self_test</refname>
    <refpurpose>This function runs a self test on the specified module</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>mcrypt_module_self_test</methodname>
      <methodparam><type>string</type><parameter>algorithm</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter></methodparam>
     </methodsynopsis>
    <para>
     This function runs the self test on the algorithm specified.  The
     optional <parameter>lib_dir</parameter> parameter can contain the
     location of where the algorithm module is on the system.
    </para>
    <para>
     The function returns &true; if the self test succeeds, or &false; when if
     fails.
    </para>
    <para>
     <example>
      <title><function>mcrypt_module_self_test</function> example</title>
      <programlisting role="php">
<![CDATA[
<?php
var_dump(mcrypt_module_self_test(MCRYPT_RIJNDAEL_128)) . "\n";
var_dump(mcrypt_module_self_test(MCRYPT_BOGUS_CYPHER));
?>
]]>
      </programlisting>
      <para>
       The above example will output:
      </para>
      <screen>
<![CDATA[
bool(true)
bool(false)
]]>
      </screen>
     </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
-->