<!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>Signs 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-setsignmode.html">gnupg_setsignmode</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.gnupg-verify.html">gnupg_verify</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-sign" class="refentry"> <div class="refnamediv"> <h1 class="refname">gnupg_sign</h1> <p class="verinfo">(PECL gnupg >= 0.1)</p><p class="refpurpose"><span class="refname">gnupg_sign</span> — <span class="dc-title">Signs a given text</span></p> </div> <div class="refsect1 description" id="refsect1-function.gnupg-sign-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">string</span> <span class="methodname"><strong>gnupg_sign</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"> Signs the given <code class="parameter">plaintext</code> with the keys, which were set with <a href="function.gnupg-addsignkey.html" class="link">gnupg_addsignkey</a> before and returns the signed text or the signature, depending on what was set with <a href="function.gnupg-setsignmode.html" class="link">gnupg_setsignmode</a>. </p> </div> <div class="refsect1 parameters" id="refsect1-function.gnupg-sign-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <code class="parameter">identifier</code></dt> <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> <code class="parameter">plaintext</code></dt> <dd> <p class="para"> The plain text being signed. </p> </dd> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.gnupg-sign-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> On success, this function returns the signed text or the signature. On failure, this function returns <strong><code>FALSE</code></strong>. </p> </div> <div class="refsect1 examples" id="refsect1-function.gnupg-sign-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4327"> <p><strong>Example #1 Procedural <span class="function"><strong>gnupg_sign()</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_addsignkey</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">,</span><span style="color: #DD0000">"test"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$signed </span><span style="color: #007700">= </span><span style="color: #0000BB">gnupg_sign</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">$signed</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> <div class="example" id="example-4328"> <p><strong>Example #2 OO <span class="function"><strong>gnupg_sign()</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">addsignkey</span><span style="color: #007700">(</span><span style="color: #DD0000">"8660281B6051D071D94B5B230549F9DC851566DC"</span><span style="color: #007700">,</span><span style="color: #DD0000">"test"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$signed </span><span style="color: #007700">= </span><span style="color: #0000BB">$gpg</span><span style="color: #007700">-></span><span style="color: #0000BB">sign</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">$signed</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-setsignmode.html">gnupg_setsignmode</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.gnupg-verify.html">gnupg_verify</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>