/
ldap-set-option.xml
309 lines (301 loc) · 9.3 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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<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>Set the value of the given option</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ldap_set_option</methodname>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>int</type><parameter>option</parameter></methodparam>
<methodparam><type>mixed</type><parameter>newval</parameter></methodparam>
</methodsynopsis>
<para>
Sets the value of the specified option to be <parameter>newval</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
An LDAP link identifier, returned by <function>ldap_connect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<para>
The parameter <parameter>option</parameter> can be one of:
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Option</entry>
<entry>Type</entry>
<entry>Available since</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>LDAP_OPT_DEREF</constant></entry>
<entry>integer</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_SIZELIMIT</constant></entry>
<entry>integer</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_TIMELIMIT</constant></entry>
<entry>integer</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_NETWORK_TIMEOUT</constant></entry>
<entry>integer</entry>
<entry>PHP 5.3.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_PROTOCOL_VERSION</constant></entry>
<entry>integer</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_ERROR_NUMBER</constant></entry>
<entry>integer</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_REFERRALS</constant></entry>
<entry>bool</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_RESTART</constant></entry>
<entry>bool</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_HOST_NAME</constant></entry>
<entry>string</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_ERROR_STRING</constant></entry>
<entry>string</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_DIAGNOSTIC_MESSAGE</constant></entry>
<entry>string</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_MATCHED_DN</constant></entry>
<entry>string</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_SERVER_CONTROLS</constant></entry>
<entry>array</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_CLIENT_CONTROLS</constant></entry>
<entry>array</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_KEEPALIVE_IDLE</constant></entry>
<entry>int</entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_KEEPALIVE_PROBES</constant></entry>
<entry>int</entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_KEEPALIVE_INTERVAL</constant></entry>
<entry>int</entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_CACERTDIR</constant></entry>
<entry>string</entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_CACERTFILE</constant></entry>
<entry>string</entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_CERTFILE</constant></entry>
<entry>string</entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_CIPHER_SUITE</constant></entry>
<entry>string</entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_CRLCHECK</constant></entry>
<entry>integer</entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_CRLFILE</constant></entry>
<entry>string</entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_DHFILE</constant></entry>
<entry>string</entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_KEYFILE</constant></entry>
<entry>string</entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_PROTOCOL_MIN</constant></entry>
<entry>integer</entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_RANDOM_FILE</constant></entry>
<entry>string</entry>
<entry>PHP 7.1.0</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_REQUIRE_CERT</constant></entry>
<entry>integer</entry>
<entry>PHP 7.0.5</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
<para>
<constant>LDAP_OPT_SERVER_CONTROLS</constant> and
<constant>LDAP_OPT_CLIENT_CONTROLS</constant> require a list of
controls, this means that the value must be an array of controls. A
control consists of an <emphasis>oid</emphasis> identifying the control,
an optional <emphasis>value</emphasis>, and an optional flag for
<emphasis>criticality</emphasis>. In PHP a control is given by an
array containing an element with the key <emphasis>oid</emphasis>
and string value, and two optional elements. The optional
elements are key <emphasis>value</emphasis> with string value
and key <emphasis>iscritical</emphasis> with boolean value.
<emphasis>iscritical</emphasis> defaults to <emphasis>&false;</emphasis>
if not supplied. See <link
xlink:href="&url.ldap.openldap-c-api;">draft-ietf-ldapext-ldap-c-api-xx.txt</link>
for details. See also the second example below.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>newval</parameter></term>
<listitem>
<para>
The new value for the specified <parameter>option</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Set protocol version</title>
<programlisting role="php">
<![CDATA[
<?php
// $ds is a valid link identifier for a directory server
if (ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3)) {
echo "Using LDAPv3";
} else {
echo "Failed to set protocol version to 3";
}
?>
]]>
</programlisting>
</example>
<example>
<title>Set server controls</title>
<programlisting role="php">
<![CDATA[
<?php
// $ds is a valid link identifier for a directory server
// control with no value
$ctrl1 = array("oid" => "1.2.752.58.10.1", "iscritical" => true);
// iscritical defaults to FALSE
$ctrl2 = array("oid" => "1.2.752.58.1.10", "value" => "magic");
// try to set both controls
if (!ldap_set_option($ds, LDAP_OPT_SERVER_CONTROLS, array($ctrl1, $ctrl2))) {
echo "Failed to set server controls";
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function is only available when using OpenLDAP 2.x.x OR 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
-->