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

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mcrypt-module-self-test" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mcrypt_module_self_test</refname>
  <refpurpose>This function runs a self test on the specified module</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <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.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>algorithm</parameter></term>
     <listitem>
      <para>
       The algorithm to test.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>lib_dir</parameter></term>
     <listitem>
      <para>
       The optional <parameter>lib_dir</parameter> parameter can contain the
       location where the algorithm module is on the system.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   The function returns &true; if the self test succeeds, or &false; when it
   fails.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <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>
    &example.outputs;
    <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:"~/.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
-->