<!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>Gets the name of the specified cipher</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mcrypt-get-block-size.html">mcrypt_get_block_size</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mcrypt-get-iv-size.html">mcrypt_get_iv_size</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-get-cipher-name" class="refentry">
<div class="refnamediv">
<h1 class="refname">mcrypt_get_cipher_name</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">mcrypt_get_cipher_name</span> — <span class="dc-title">Gets the name of the specified cipher</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.mcrypt-get-cipher-name-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>mcrypt_get_cipher_name</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$cipher</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>mcrypt_get_cipher_name</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$cipher</code></span>
)</div>
<p class="para rdfs-comment">
<span class="function"><strong>mcrypt_get_cipher_name()</strong></span> is used to get the
name of the specified cipher.
</p>
<p class="para">
<span class="function"><strong>mcrypt_get_cipher_name()</strong></span> 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 <strong><code>FALSE</code></strong>, if the cipher does not exist.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.mcrypt-get-cipher-name-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">cipher</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>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.mcrypt-get-cipher-name-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
This function returns the name of the cipher or <strong><code>FALSE</code></strong> if the cipher does
not exist.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.mcrypt-get-cipher-name-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-845">
<p><strong>Example #1 <span class="function"><strong>mcrypt_get_cipher_name()</strong></span> Example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /> $cipher </span><span style="color: #007700">= </span><span style="color: #0000BB">MCRYPT_TripleDES</span><span style="color: #007700">;<br /><br /> echo </span><span style="color: #0000BB">mcrypt_get_cipher_name</span><span style="color: #007700">(</span><span style="color: #0000BB">$cipher</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>
3DES
</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-get-block-size.html">mcrypt_get_block_size</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mcrypt-get-iv-size.html">mcrypt_get_iv_size</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>
