gnupg-init.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.gnupg-init">
 <refnamediv>
  <refname>gnupg_init</refname>
  <refpurpose>Initialize a connection</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>gnupg_init</methodname>
   <methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       Must be an associative array. It is used to change the default configuration
       of the crypto engine.
       <table>
        <title>Configuration overrides</title>
        <tgroup cols="3">
         <thead>
          <row>
           <entry>key</entry>
           <entry>type</entry>
           <entry>description</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>file_name</entry>
           <entry><type>string</type></entry>
           <entry>
            It is the file name of the executable program implementing this protocol
            which is usually path of the <literal>gpg</literal> executable.
           </entry>
          </row>
          <row>
           <entry>home_dir</entry>
           <entry><type>string</type></entry>
           <entry>
            It is the directory name of the configuration directory. It also overrides
            <literal>GNUPGHOME</literal> environment variable that is used for the same
            purpose.
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   A GnuPG <type>resource</type> connection used by other GnuPG functions.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>PECL gnupg 1.5.0</entry>
      <entry>The <parameter>options</parameter> parameter was added.</entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Procedural <function>gnupg_init</function> example with default setting</title>
    <programlisting role="php">
<![CDATA[
<?php
$res = gnupg_init();
?>
]]>
    </programlisting>
   </example>
   <example>
    <title>Procedural <function>gnupg_init</function> example with overriden file name and home dir</title>
    <programlisting role="php">
<![CDATA[
<?php
$res = gnupg_init(["file_name" => "/usr/bin/gpg2", "home_dir" => "/var/www/.gnupg"]);
?>
]]>
    </programlisting>
   </example>
   <example>
    <title>OO gnupg initializer example with default setting</title>
    <programlisting role="php">
<![CDATA[
<?php
$gpg = new gnupg();
?>
]]>
    </programlisting>
   </example>
   <example>
    <title>OO gnupg initializer example with overriden file name and home dir</title>
    <programlisting role="php">
<![CDATA[
<?php
$gpg = new gnupg(["file_name" => "/usr/bin/gpg2", "home_dir" => "/var/www/.gnupg"]);
?>
]]>
    </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
-->