mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 06:18:56 +00:00
a56106f691
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@317502 c90b9560-bf6c-de11-be94-00142212c4b1
107 lines
2.7 KiB
XML
107 lines
2.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.gnupg-sign">
|
|
<refnamediv>
|
|
<refname>gnupg_sign</refname>
|
|
<refpurpose>Signs a given text</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>gnupg_sign</methodname>
|
|
<methodparam><type>resource</type><parameter>identifier</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>plaintext</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Signs the given <parameter>plaintext</parameter> with the keys, which were
|
|
set with <link
|
|
linkend="function.gnupg-addsignkey">gnupg_addsignkey</link> before and
|
|
returns the signed text or the signature, depending on what was set with
|
|
<link linkend="function.gnupg-setsignmode">gnupg_setsignmode</link>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>identifier</parameter></term>
|
|
<listitem>
|
|
&gnupg.identifier;
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>plaintext</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The plain text being signed.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
On success, this function returns the signed text or the signature.
|
|
On failure, this function returns &false;.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Procedural <function>gnupg_sign</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$res = gnupg_init();
|
|
gnupg_addsignkey($res,"8660281B6051D071D94B5B230549F9DC851566DC","test");
|
|
$signed = gnupg_sign($res, "just a test");
|
|
echo $signed;
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
<example>
|
|
<title>OO <function>gnupg_sign</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$gpg = new gnupg();
|
|
$gpg -> setsignkey("8660281B6051D071D94B5B230549F9DC851566DC","test");
|
|
$signed = $gpg -> sign("just a test");
|
|
echo $signed;
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</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
|
|
-->
|