Document gnupg_listsignatures

reference/gnupg/functions/gnupg-listsignatures.xml

@@ -0,0 +1,98 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.gnupg-listsignatures">
+ <refnamediv>
+  <refname>gnupg_listsignatures</refname>
+  <refpurpose>List key signatures</refpurpose>
+ </refnamediv>
+ 
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>array</type><methodname>gnupg_listsignatures</methodname>
+   <methodparam><type>resource</type><parameter>identifier</parameter></methodparam>
+   <methodparam><type>string</type><parameter>keyid</parameter></methodparam>
+  </methodsynopsis>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>identifier</parameter></term>
+     <listitem>
+      &gnupg.identifier;
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>keyid</parameter></term>
+     <listitem>
+      <para>
+       The key ID to list signatures for.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   On success, this function returns an array of key signatures.
+   On failure, this function returns &null;.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>Procedural <function>gnupg_listsignatures</function> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$res = gnupg_init();
+$signatures = gnupg_listsignatures($res, "8660281B6051D071D94B5B230549F9DC851566DC");
+print_r($signatures);
+?>
+]]>
+    </programlisting>
+   </example>
+   <example>
+    <title>OO <function>gnupg_listsignatures</function> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$gpg = new gnupg();
+$signatures = $gpg->listsignatures("8660281B6051D071D94B5B230549F9DC851566DC");
+print_r($signatures);
+?>
+]]>
+    </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
+-->