php-doc-en/reference/mcrypt/functions/mcrypt-get-cipher-name.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mcrypt-get-cipher-name" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mcrypt_get_cipher_name</refname>
  <refpurpose>Get the name of the specified cipher</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>mcrypt_get_cipher_name</methodname>
   <methodparam><type>int</type><parameter>cipher</parameter></methodparam>
  </methodsynopsis>
  <methodsynopsis>
   <type>string</type><methodname>mcrypt_get_cipher_name</methodname>
   <methodparam><type>string</type><parameter>cipher</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>mcrypt_get_cipher_name</function> is used to get the
   name of the specified cipher.
  </para>
  <para>
   <function>mcrypt_get_cipher_name</function> takes the cipher
   number as an argument (libmcrypt 2.2.x) or takes the cipher name
   as an argument (libmcrypt 2.4.x or higher) and returns the name of the cipher
   or &false;, if the cipher does not exist.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>cipher</parameter></term>
     <listitem>
      <para>
       One of the <literal>MCRYPT_ciphername</literal> constants or the name
       of the algorithm as string.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   This function returns the name of the cipher or &false;, if the cipher does
   not exist.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>mcrypt_get_cipher_name</function> Example</title>
    <programlisting role="php">
<![CDATA[
<?php
   $cipher = MCRYPT_TripleDES;

   echo mcrypt_get_cipher_name($cipher);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
3DES
]]>
    </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
-->