-
Notifications
You must be signed in to change notification settings - Fork 79
/
Copy pathldap-set-option.xml
333 lines (325 loc) · 10.9 KB
/
ldap-set-option.xml
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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: a8a81b5185dcdd0722c356b573349b907aba9609 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi,mumumu -->
<refentry xml:id="function.ldap-set-option" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ldap_set_option</refname>
<refpurpose>指定したオプションの値を設定する</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ldap_set_option</methodname>
<methodparam><type class="union"><type>LDAP\Connection</type><type>null</type></type><parameter>ldap</parameter></methodparam>
<methodparam><type>int</type><parameter>option</parameter></methodparam>
<methodparam><type class="union"><type>array</type><type>string</type><type>int</type><type>bool</type></type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
指定したオプションの値を <parameter>value</parameter> に設定します。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>ldap</parameter></term>
<listitem>
<para>
特定の接続に対してオプションを設定する場合は、
<function>ldap_connect</function> が返す、
<classname>LDAP\Connection</classname>
クラスのインスタンス。
オプションをグローバルに設定する場合は、
&null; を設定します。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<para>
パラメータ <parameter>option</parameter> は以下のいずれかとなります。
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>オプション</entry>
<entry>型</entry>
<entry>～以降で使用可能</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>LDAP_OPT_DEREF</constant></entry>
<entry><type>int</type></entry>
<entry/>
</row>
<row>
<entry><constant>LDAP_OPT_SIZELIMIT</constant></entry>
<entry><type>int</type></entry>
<entry/>
</row>
<row>
<entry><constant>LDAP_OPT_TIMELIMIT</constant></entry>
<entry><type>int</type></entry>
<entry/>
</row>
<row>
<entry><constant>LDAP_OPT_NETWORK_TIMEOUT</constant></entry>
<entry><type>int</type></entry>
<entry/>
</row>
<row>
<entry><constant>LDAP_OPT_PROTOCOL_VERSION</constant></entry>
<entry><type>int</type></entry>
<entry/>
</row>
<row>
<entry><constant>LDAP_OPT_ERROR_NUMBER</constant></entry>
<entry><type>int</type></entry>
<entry/>
</row>
<row>
<entry><constant>LDAP_OPT_REFERRALS</constant></entry>
<entry><type>bool</type></entry>
<entry/>
</row>
<row>
<entry><constant>LDAP_OPT_RESTART</constant></entry>
<entry><type>bool</type></entry>
<entry/>
</row>
<row>
<entry><constant>LDAP_OPT_HOST_NAME</constant></entry>
<entry><type>string</type></entry>
<entry/>
</row>
<row>
<entry><constant>LDAP_OPT_ERROR_STRING</constant></entry>
<entry><type>string</type></entry>
<entry/>
</row>
<row>
<entry><constant>LDAP_OPT_DIAGNOSTIC_MESSAGE</constant></entry>
<entry><type>string</type></entry>
<entry/>
</row>
<row>
<entry><constant>LDAP_OPT_MATCHED_DN</constant></entry>
<entry><type>string</type></entry>
<entry/>
</row>
<row>
<entry><constant>LDAP_OPT_SERVER_CONTROLS</constant></entry>
<entry><type>array</type></entry>
<entry/>
</row>
<row>
<entry><constant>LDAP_OPT_CLIENT_CONTROLS</constant></entry>
<entry><type>array</type></entry>
<entry/>
</row>
<row>
<entry><constant>LDAP_OPT_X_KEEPALIVE_IDLE</constant></entry>
<entry><type>int</type></entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_KEEPALIVE_PROBES</constant></entry>
<entry><type>int</type></entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_KEEPALIVE_INTERVAL</constant></entry>
<entry><type>int</type></entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_CACERTDIR</constant></entry>
<entry><type>string</type></entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_CACERTFILE</constant></entry>
<entry><type>string</type></entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_CERTFILE</constant></entry>
<entry><type>string</type></entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_CIPHER_SUITE</constant></entry>
<entry><type>string</type></entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_CRLCHECK</constant></entry>
<entry><type>int</type></entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_CRLFILE</constant></entry>
<entry><type>string</type></entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_DHFILE</constant></entry>
<entry><type>string</type></entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_KEYFILE</constant></entry>
<entry><type>string</type></entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_PROTOCOL_MIN</constant></entry>
<entry><type>int</type></entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_RANDOM_FILE</constant></entry>
<entry><type>string</type></entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_REQUIRE_CERT</constant></entry>
<entry><type>int</type></entry>
<entry>PHP 7.0.5</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<para>
<constant>LDAP_OPT_SERVER_CONTROLS</constant> および
<constant>LDAP_OPT_CLIENT_CONTROLS</constant>
はコントロールのリストが必要です。
つまり、値がコントロールの配列である必要があるということです。
コントロールは、そのコントロールの ID
である <emphasis>oid</emphasis>、オプションの
<emphasis>value</emphasis>、オプションのフラグ
<emphasis>criticality</emphasis> からなります。PHP において、
コントロールはキーが <emphasis>oid</emphasis> で値が文字列、
二つのオプションの要素からなる配列で指定されます。オプションの要素は、
キーが <emphasis>value</emphasis> で値が文字列、そしてキーが
<emphasis>iscritical</emphasis> で値が論理値となります。
<emphasis>iscritical</emphasis> を省略した場合のデフォルトは
<emphasis>&false;</emphasis> です。詳細は <link
xlink:href="&url.ldap.openldap-c-api;">draft-ietf-ldapext-ldap-c-api-xx.txt</link>
を参照ください。また以下の二番目の例も参照ください。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
指定したオプション <parameter>option</parameter> の新しい値。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&ldap.changelog.ldap-object;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>プロトコルバージョンの設定</title>
<programlisting role="php">
<![CDATA[
<?php
// $ds はディレクトリサーバーへの LDAP\Connection のインスタンス
if (ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3)) {
echo "LDAPv3 を使用します";
} else {
echo "プロトコルバージョンを 3 に設定できませんでした";
}
?>
]]>
</programlisting>
</example>
<example>
<title>サーバーコントロールの設定</title>
<programlisting role="php">
<![CDATA[
<?php
// $ds は値を持たないディレクトリサーバーコントロールへの LDAP\Connection のインスタンスです。
$ctrl1 = array("oid" => "1.2.752.58.10.1", "iscritical" => true);
// iscritical のデフォルトは、FALSE です。
$ctrl2 = array("oid" => "1.2.752.58.1.10", "value" => "magic");
// 両方のコントロールを試します
if (!ldap_set_option($ds, LDAP_OPT_SERVER_CONTROLS, array($ctrl1, $ctrl2))) {
echo "サーバーコントロールの設定に失敗しました。";
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
この関数は、OpenLDAP 2.x.x または Netscape Directory SDK x.x
を使用している場合のみ利用可能です。
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ldap_get_option</function></member>
</simplelist>
</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
-->