doc-ru/reference/gnupg/functions/gnupg-init.xml at 2e4877249dfd64ce39a9bb43c40072618f10c6a2 · php/doc-ru · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 32040dd7e5d98c136502134110681f80443dd000 Maintainer: bfl Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.gnupg-init">
 <refnamediv>
  <refname>gnupg_init</refname>
  <refpurpose>Инициализирует подключение к функциям модуля GnuPG</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;
  <variablelist>
   <varlistentry>
    <term><parameter>options</parameter></term>
    <listitem>
     <para>
      Параметр принимает ассоциативный массив,
      который изменяет первоначальную конфигурацию криптографического движка.
      <table>
       <title>Переопределения конфигурации</title>
       <tgroup cols="3">
        <thead>
         <row>
          <entry>Ключ</entry>
          <entry>Тип</entry>
          <entry>Описание</entry>
         </row>
        </thead>
        <tbody>
         <row>
          <entry>file_name</entry>
          <entry><type>string</type></entry>
          <entry>
           Название файла исполняемой программы, которая реализует протокол стандарта OpenPGP.
           Название файла обычно указывают как путь к исполняемому файлу <literal>gpg</literal>.
          </entry>
         </row>
         <row>
          <entry>home_dir</entry>
          <entry><type>string</type></entry>
          <entry>
           Название каталога конфигурации. Значение переопределит переменную окружения
           <literal>GNUPGHOME</literal>, которая выполняет ту же задачу — указывает каталог конфигурации.
          </entry>
         </row>
        </tbody>
       </tgroup>
      </table>
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   Функция возвращает ресурс (<type>resource</type>) подключения к функциям модуля GnuPG.
   Ресурс будут использовать другие функции модуля GnuPG.
  </simpara>
 </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>
       Разработчики языка добавили параметр <parameter>options</parameter>.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>
     Пример использования функции <function>gnupg_init</function> в процедурном стиле
     с настройками по умолчанию
    </title>
    <programlisting role="php">
<![CDATA[
<?php

$res = gnupg_init();

?>
]]>
    </programlisting>
   </example>
   <example>
    <title>
     Пример использования <function>gnupg_init</function> в процедурном стиле
     с переопределением имени исполняемого файла и домашнего каталога конфигурации
    </title>
    <programlisting role="php">
<![CDATA[
<?php

$res = gnupg_init(["file_name" => "/usr/bin/gpg2", "home_dir" => "/var/www/.gnupg"]);

?>
]]>
    </programlisting>
   </example>
   <example>
    <title>
     Пример создания инициализатора класса gnupg в объектно-ориентированном стиле
     с настройками по умолчанию
    </title>
    <programlisting role="php">
<![CDATA[
<?php

$gpg = new gnupg();

?>
]]>
    </programlisting>
   </example>
   <example>
    <title>
     Пример создания инициализатора класса gnupg в объектно-ориентированном стиле
     с переопределением имени исполняемого файла и домашнего каталога конфигурации
    </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
-->