reference/ldap/functions/ldap-get-option.xml
3ec3fa6848aae4b4535557105a42fbf8d57dcc07
...
...
@@ -10,12 +10,12 @@
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>bool</type><methodname>ldap_get_option</methodname>
13
-
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
13
+
<methodparam><type>LDAP\Connection</type><parameter>ldap</parameter></methodparam>
14
14
<methodparam><type>int</type><parameter>option</parameter></methodparam>
15
-
<methodparam><type>mixed</type><parameter role="reference">retval</parameter></methodparam>
15
+
<methodparam choice="opt"><type class="union"><type>array</type><type>string</type><type>int</type></type><parameter role="reference">value</parameter><initializer>&null;</initializer></methodparam>
16
16
</methodsynopsis>
17
17
<para>
18
-
Sets <parameter>retval</parameter> to the value of the specified option.
18
+
Sets <parameter>value</parameter> to the value of the specified option.
19
19
</para>
20
20
</refsect1>
21
21

...
...
@@ -24,10 +24,10 @@
24
24
<para>
25
25
<variablelist>
26
26
<varlistentry>
27
-
<term><parameter>link_identifier</parameter></term>
27
+
<term><parameter>ldap</parameter></term>
28
28
<listitem>
29
29
<para>
30
-
An LDAP link identifier, returned by <function>ldap_connect</function>.
30
+
&ldap.parameter.ldap;
31
31
</para>
32
32
</listitem>
33
33
</varlistentry>
...
...
@@ -37,140 +37,174 @@
37
37
<para>
38
38
The parameter <parameter>option</parameter> can be one of:
39
39
<informaltable>
40
-
<tgroup cols="2">
40
+
<tgroup cols="3">
41
41
<thead>
42
42
<row>
43
43
<entry>Option</entry>
44
44
<entry>Type</entry>
45
+
<entry>since</entry>
45
46
</row>
46
47
</thead>
47
48
<tbody>
48
49
<row>
49
50
<entry><constant>LDAP_OPT_DEREF</constant></entry>
50
-
<entry>integer</entry>
51
+
<entry><type>int</type></entry>
52
+
<entry/>
51
53
</row>
52
54
<row>
53
55
<entry><constant>LDAP_OPT_SIZELIMIT</constant></entry>
54
-
<entry>integer</entry>
56
+
<entry><type>int</type></entry>
57
+
<entry/>
55
58
</row>
56
59
<row>
57
60
<entry><constant>LDAP_OPT_TIMELIMIT</constant></entry>
58
-
<entry>integer</entry>
61
+
<entry><type>int</type></entry>
62
+
<entry/>
59
63
</row>
60
64
<row>
61
65
<entry><constant>LDAP_OPT_NETWORK_TIMEOUT</constant></entry>
62
-
<entry>integer</entry>
66
+
<entry><type>int</type></entry>
67
+
<entry/>
63
68
</row>
64
69
<row>
65
70
<entry><constant>LDAP_OPT_PROTOCOL_VERSION</constant></entry>
66
-
<entry>integer</entry>
71
+
<entry><type>int</type></entry>
72
+
<entry/>
67
73
</row>
68
74
<row>
69
75
<entry><constant>LDAP_OPT_ERROR_NUMBER</constant></entry>
70
-
<entry>integer</entry>
76
+
<entry><type>int</type></entry>
77
+
<entry/>
78
+
</row>
79
+
<row>
80
+
<entry><constant>LDAP_OPT_DIAGNOSTIC_MESSAGE</constant></entry>
81
+
<entry><type>string</type></entry>
82
+
<entry/>
71
83
</row>
72
84
<row>
73
85
<entry><constant>LDAP_OPT_REFERRALS</constant></entry>
74
-
<entry>bool</entry>
86
+
<entry><type>int</type></entry>
87
+
<entry/>
75
88
</row>
76
89
<row>
77
90
<entry><constant>LDAP_OPT_RESTART</constant></entry>
78
-
<entry>bool</entry>
91
+
<entry><type>int</type></entry>
92
+
<entry/>
79
93
</row>
80
94
<row>
81
95
<entry><constant>LDAP_OPT_HOST_NAME</constant></entry>
82
-
<entry>string</entry>
96
+
<entry><type>string</type></entry>
97
+
<entry/>
83
98
</row>
84
99
<row>
85
100
<entry><constant>LDAP_OPT_ERROR_STRING</constant></entry>
86
-
<entry>string</entry>
101
+
<entry><type>string</type></entry>
102
+
<entry/>
87
103
</row>
88
104
<row>
89
105
<entry><constant>LDAP_OPT_MATCHED_DN</constant></entry>
90
-
<entry>string</entry>
106
+
<entry><type>string</type></entry>
107
+
<entry/>
91
108
</row>
92
109
<row>
93
110
<entry><constant>LDAP_OPT_SERVER_CONTROLS</constant></entry>
94
-
<entry>array</entry>
111
+
<entry><type>array</type></entry>
112
+
<entry/>
95
113
</row>
96
114
<row>
97
115
<entry><constant>LDAP_OPT_CLIENT_CONTROLS</constant></entry>
98
-
<entry>array</entry>
116
+
<entry><type>array</type></entry>
117
+
<entry/>
99
118
</row>
100
119
<row>
101
120
<entry><constant>LDAP_OPT_X_KEEPALIVE_IDLE</constant></entry>
102
-
<entry>int</entry>
103
-
<entry></entry>
121
+
<entry><type>int</type></entry>
122
+
<entry>7.1</entry>
104
123
</row>
105
124
<row>
106
125
<entry><constant>LDAP_OPT_X_KEEPALIVE_PROBES</constant></entry>
107
-
<entry>int</entry>
108
-
<entry></entry>
126
+
<entry><type>int</type></entry>
127
+
<entry>7.1</entry>
109
128
</row>
110
129
<row>
111
130
<entry><constant>LDAP_OPT_X_KEEPALIVE_INTERVAL</constant></entry>
112
-
<entry>int</entry>
113
-
<entry></entry>
131
+
<entry><type>int</type></entry>
132
+
<entry>7.1</entry>
114
133
</row>
115
134
<row>
116
135
<entry><constant>LDAP_OPT_X_TLS_CACERTDIR</constant></entry>
117
-
<entry>string</entry>
118
-
<entry></entry>
136
+
<entry><type>string</type></entry>
137
+
<entry>7.1</entry>
119
138
</row>
120
139
<row>
121
140
<entry><constant>LDAP_OPT_X_TLS_CACERTFILE</constant></entry>
122
-
<entry>string</entry>
123
-
<entry></entry>
141
+
<entry><type>string</type></entry>
142
+
<entry>7.1</entry>
124
143
</row>
125
144
<row>
126
145
<entry><constant>LDAP_OPT_X_TLS_CERTFILE</constant></entry>
127
-
<entry>string</entry>
128
-
<entry></entry>
146
+
<entry><type>string</type></entry>
147
+
<entry>7.1</entry>
129
148
</row>
130
149
<row>
131
150
<entry><constant>LDAP_OPT_X_TLS_CIPHER_SUITE</constant></entry>
132
-
<entry>string</entry>
133
-
<entry></entry>
151
+
<entry><type>string</type></entry>
152
+
<entry>7.1</entry>
134
153
</row>
135
154
<row>
136
155
<entry><constant>LDAP_OPT_X_TLS_CRLCHECK</constant></entry>
137
-
<entry>integer</entry>
138
-
<entry></entry>
156
+
<entry><type>int</type></entry>
157
+
<entry>7.1</entry>
158
+
</row>
159
+
<row>
160
+
<entry><constant>LDAP_OPT_X_TLS_CRL_NONE</constant></entry>
161
+
<entry><type>int</type></entry>
162
+
<entry>7.1</entry>
163
+
</row>
164
+
<row>
165
+
<entry><constant>LDAP_OPT_X_TLS_CRL_PEER</constant></entry>
166
+
<entry><type>int</type></entry>
167
+
<entry>7.1</entry>
168
+
</row>
169
+
<row>
170
+
<entry><constant>LDAP_OPT_X_TLS_CRL_ALL</constant></entry>
171
+
<entry><type>int</type></entry>
172
+
<entry>7.1</entry>
139
173
</row>
140
174
<row>
141
175
<entry><constant>LDAP_OPT_X_TLS_CRLFILE</constant></entry>
142
-
<entry>string</entry>
143
-
<entry></entry>
176
+
<entry><type>string</type></entry>
177
+
<entry>7.1</entry>
144
178
</row>
145
179
<row>
146
180
<entry><constant>LDAP_OPT_X_TLS_DHFILE</constant></entry>
147
-
<entry>string</entry>
148
-
<entry></entry>
181
+
<entry><type>string</type></entry>
182
+
<entry>7.1</entry>
149
183
</row>
150
184
<row>
151
-
<entry><constant>LDAP_OPT_X_TLS_KEYILE</constant></entry>
152
-
<entry>string</entry>
153
-
<entry></entry>
185
+
<entry><constant>LDAP_OPT_X_TLS_KEYFILE</constant></entry>
186
+
<entry><type>string</type></entry>
187
+
<entry>7.1</entry>
154
188
</row>
155
189
<row>
156
190
<entry><constant>LDAP_OPT_X_TLS_PACKAGE</constant></entry>
157
-
<entry>string</entry>
158
-
<entry></entry>
191
+
<entry><type>string</type></entry>
192
+
<entry>7.1</entry>
159
193
</row>
160
194
<row>
161
195
<entry><constant>LDAP_OPT_X_TLS_PROTOCOL_MIN</constant></entry>
162
-
<entry>integer</entry>
163
-
<entry></entry>
196
+
<entry><type>int</type></entry>
197
+
<entry>7.1</entry>
164
198
</row>
165
199
<row>
166
200
<entry><constant>LDAP_OPT_X_TLS_RANDOM_FILE</constant></entry>
167
-
<entry>string</entry>
168
-
<entry></entry>
201
+
<entry><type>string</type></entry>
202
+
<entry>7.1</entry>
169
203
</row>
170
204
<row>
171
205
<entry><constant>LDAP_OPT_X_TLS_REQUIRE_CERT</constant></entry>
172
-
<entry>integer</entry>
173
-
<entry></entry>
206
+
<entry><type>int</type></entry>
207
+
<entry/>
174
208
</row>
175
209
</tbody>
176
210
</tgroup>
...
...
@@ -179,7 +213,7 @@
179
213
</listitem>
180
214
</varlistentry>
181
215
<varlistentry>
182
-
<term><parameter>retval</parameter></term>
216
+
<term><parameter>value</parameter></term>
183
217
<listitem>
184
218
<para>
185
219
This will be set to the option value.
...
...
@@ -197,6 +231,23 @@
197
231
</para>
198
232
</refsect1>
199
233

234
+
<refsect1 role="changelog">
235
+
&reftitle.changelog;
236
+
<informaltable>
237
+
<tgroup cols="2">
238
+
<thead>
239
+
<row>
240
+
<entry>&Version;</entry>
241
+
<entry>&Description;</entry>
242
+
</row>
243
+
</thead>
244
+
<tbody>
245
+
&ldap.changelog.ldap-object;
246
+
</tbody>
247
+
</tgroup>
248
+
</informaltable>
249
+
</refsect1>
250
+

200
251
<refsect1 role="examples">
201
252
&reftitle.examples;
202
253
<para>
...
...
@@ -205,7 +256,7 @@
205
256
<programlisting role="php">
206
257
<![CDATA[
207
258
<?php
208
-
// $ds is a valid link identifier for a directory server
259
+
// $ds is a valid LDAP\Connection instance for a directory server
209
260
if (ldap_get_option($ds, LDAP_OPT_PROTOCOL_VERSION, $version)) {
210
261
echo "Using protocol version $version\n";
211
262
} else {
...
...
@@ -238,7 +289,6 @@ if (ldap_get_option($ds, LDAP_OPT_PROTOCOL_VERSION, $version)) {
238
289
</refsect1>
239
290

240
291
</refentry>
241
-

242
292
<!-- Keep this comment at the end of the file
243
293
Local variables:
244
294
mode: sgml
245
295



Tools (Spanish Manual)