<!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>Sets the mode for signing</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.gnupg-seterrormode.html">gnupg_seterrormode</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.gnupg-sign.html">gnupg_sign</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-setsignmode" class="refentry"> <div class="refnamediv"> <h1 class="refname">gnupg_setsignmode</h1> <p class="verinfo">(PECL gnupg >= 0.1)</p><p class="refpurpose"><span class="refname">gnupg_setsignmode</span> — <span class="dc-title">Sets the mode for signing</span></p> </div> <div class="refsect1 description" id="refsect1-function.gnupg-setsignmode-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>gnupg_setsignmode</strong></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$identifier</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter">$signmode</code></span> )</div> <p class="para rdfs-comment"> Sets the mode for signing. </p> </div> <div class="refsect1 parameters" id="refsect1-function.gnupg-setsignmode-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">sigmode</code></em></span> <dd> <p class="para"> The mode for signing. </p> <p class="para"> <em><code class="parameter">signmode</code></em> takes a constant indicating what type of signature should be produced. The possible values are <strong><code>GNUPG_SIG_MODE_NORMAL</code></strong>, <strong><code>GNUPG_SIG_MODE_DETACH</code></strong> and <strong><code>GNUPG_SIG_MODE_CLEAR</code></strong>. By default <strong><code>GNUPG_SIG_MODE_CLEAR</code></strong> is used. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.gnupg-setsignmode-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 examples" id="refsect1-function.gnupg-setsignmode-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-3529"> <p><strong>Example #1 Procedural <span class="function"><strong>gnupg_setsignmode()</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_setsignmode</span><span style="color: #007700">(</span><span style="color: #0000BB">$res</span><span style="color: #007700">,</span><span style="color: #0000BB">GNUPG_SIG_MODE_DETACH</span><span style="color: #007700">); </span><span style="color: #FF8000">// produce a detached signature<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> <div class="example" id="example-3530"> <p><strong>Example #2 OO <span class="function"><strong>gnupg_setsignmode()</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">setsignmode</span><span style="color: #007700">(</span><span style="color: #0000BB">gnupg</span><span style="color: #007700">::</span><span style="color: #0000BB">SIG_MODE_DETACH</span><span style="color: #007700">); </span><span style="color: #FF8000">// produce a detached signature<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-seterrormode.html">gnupg_seterrormode</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.gnupg-sign.html">gnupg_sign</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>