<!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>Encrypts a given text</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.gnupg-decryptverify.html">gnupg_decryptverify</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.gnupg-encryptsign.html">gnupg_encryptsign</a></div>
<div class="up"><a href="ref.gnupg.html">GnuPG Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.gnupg-encrypt" class="refentry">
<div class="refnamediv">
<h1 class="refname">gnupg_encrypt</h1>
<p class="verinfo">(PECL gnupg >= 0.1)</p><p class="refpurpose"><span class="refname">gnupg_encrypt</span> — <span class="dc-title">Encrypts a given text</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.gnupg-encrypt-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>gnupg_encrypt</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$identifier</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$plaintext</code></span>
)</div>
<p class="para rdfs-comment">
Encrypts the given <em><code class="parameter">plaintext</code></em> with the keys, which
were set with <a href="function.gnupg-addencryptkey.html" class="link">gnupg_addencryptkey</a> before and
returns the encrypted text.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.gnupg-encrypt-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">identifier</code></em></span>
<dd>
<p class="para">The gnupg identifier, from a call to
<span class="function"><a href="function.gnupg-init.html" class="function">gnupg_init()</a></span> or <strong class="classname">gnupg</strong>.</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">plaintext</code></em></span>
<dd>
<p class="para">
The text being encrypted.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.gnupg-encrypt-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
On success, this function returns the encrypted text.
On failure, this function returns <strong><code>FALSE</code></strong>.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.gnupg-encrypt-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3509">
<p><strong>Example #1 Procedural <span class="function"><strong>gnupg_encrypt()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$res </span><span style="color: #007700">= </span><span style="color: #0000BB">gnupg_init</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">gnupg_addencryptkey</span><span style="color: #007700">(</span><span style="color: #0000BB">$res</span><span style="color: #007700">,</span><span style="color: #DD0000">"8660281B6051D071D94B5B230549F9DC851566DC"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$enc </span><span style="color: #007700">= </span><span style="color: #0000BB">gnupg_encrypt</span><span style="color: #007700">(</span><span style="color: #0000BB">$res</span><span style="color: #007700">, </span><span style="color: #DD0000">"just a test"</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$enc</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="example-3510">
<p><strong>Example #2 OO <span class="function"><strong>gnupg_encrypt()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$gpg </span><span style="color: #007700">= new </span><span style="color: #0000BB">gnupg</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$gpg </span><span style="color: #007700">-> </span><span style="color: #0000BB">addencryptkey</span><span style="color: #007700">(</span><span style="color: #DD0000">"8660281B6051D071D94B5B230549F9DC851566DC"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$enc </span><span style="color: #007700">= </span><span style="color: #0000BB">$gpg </span><span style="color: #007700">-> </span><span style="color: #0000BB">encrypt</span><span style="color: #007700">(</span><span style="color: #DD0000">"just a test"</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$enc</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span>
</span>
</code></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.gnupg-decryptverify.html">gnupg_decryptverify</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.gnupg-encryptsign.html">gnupg_encryptsign</a></div>
<div class="up"><a href="ref.gnupg.html">GnuPG Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
