reference/ldap/functions/ldap-read.xml
b7cbd468cb4c46d55d43a44cade0eb4590d25dea
b7cbd468cb4c46d55d43a44cade0eb4590d25dea
...
...
@@ -9,21 +9,23 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>resource</type><methodname>ldap_read</methodname>
13
-
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
14
-
<methodparam><type>string</type><parameter>base_dn</parameter></methodparam>
15
-
<methodparam><type>string</type><parameter>filter</parameter></methodparam>
16
-
<methodparam choice="opt"><type>array</type><parameter>attributes</parameter></methodparam>
17
-
<methodparam choice="opt"><type>int</type><parameter>attrsonly</parameter></methodparam>
18
-
<methodparam choice="opt"><type>int</type><parameter>sizelimit</parameter></methodparam>
19
-
<methodparam choice="opt"><type>int</type><parameter>timelimit</parameter></methodparam>
20
-
<methodparam choice="opt"><type>int</type><parameter>deref</parameter></methodparam>
12
+
<type class="union"><type>LDAP\Result</type><type>array</type><type>false</type></type><methodname>ldap_read</methodname>
13
+
<methodparam><type class="union"><type>LDAP\Connection</type><type>array</type></type><parameter>ldap</parameter></methodparam>
14
+
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>base</parameter></methodparam>
15
+
<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>filter</parameter></methodparam>
16
+
<methodparam choice="opt"><type>array</type><parameter>attributes</parameter><initializer>[]</initializer></methodparam>
17
+
<methodparam choice="opt"><type>int</type><parameter>attributes_only</parameter><initializer>0</initializer></methodparam>
18
+
<methodparam choice="opt"><type>int</type><parameter>sizelimit</parameter><initializer>-1</initializer></methodparam>
19
+
<methodparam choice="opt"><type>int</type><parameter>timelimit</parameter><initializer>-1</initializer></methodparam>
20
+
<methodparam choice="opt"><type>int</type><parameter>deref</parameter><initializer><constant>LDAP_DEREF_NEVER</constant></initializer></methodparam>
21
+
<methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>controls</parameter><initializer>&null;</initializer></methodparam>
21
22
</methodsynopsis>
22
23
<para>
23
24
Performs the search for a specified <parameter>filter</parameter> on the
24
25
directory with the scope <constant>LDAP_SCOPE_BASE</constant>. So it is
25
26
equivalent to reading an entry from the directory.
26
27
</para>
28
+
&ldap.return-result-array-info;
27
29
</refsect1>
28
30
29
31
<refsect1 role="parameters">
...
...
@@ -31,15 +33,15 @@
31
33
<para>
32
34
<variablelist>
33
35
<varlistentry>
34
-
<term><parameter>link_identifier</parameter></term>
36
+
<term><parameter>ldap</parameter></term>
35
37
<listitem>
36
38
<para>
37
-
An LDAP link identifier, returned by <function>ldap_connect</function>.
39
+
&ldap.parameter.ldap;
38
40
</para>
39
41
</listitem>
40
42
</varlistentry>
41
43
<varlistentry>
42
-
<term><parameter>base_dn</parameter></term>
44
+
<term><parameter>base</parameter></term>
43
45
<listitem>
44
46
<para>
45
47
The base DN for the directory.
...
...
@@ -75,7 +77,7 @@
75
77
</listitem>
76
78
</varlistentry>
77
79
<varlistentry>
78
-
<term><parameter>attrsonly</parameter></term>
80
+
<term><parameter>attributes_only</parameter></term>
79
81
<listitem>
80
82
<para>
81
83
Should be set to 1 if only attribute types are wanted. If set to 0
...
...
@@ -156,6 +158,14 @@
156
158
</para>
157
159
</listitem>
158
160
</varlistentry>
161
+
<varlistentry>
162
+
<term><parameter>controls</parameter></term>
163
+
<listitem>
164
+
<para>
165
+
Array of <link linkend="ldap.controls">LDAP Controls</link> to send with the request.
166
+
</para>
167
+
</listitem>
168
+
</varlistentry>
159
169
</variablelist>
160
170
</para>
161
171
</refsect1>
...
...
@@ -163,7 +173,7 @@
163
173
<refsect1 role="returnvalues">
164
174
&reftitle.returnvalues;
165
175
<para>
166
-
Returns a search result identifier or &false; on error.
176
+
&ldap.return-result-array;
167
177
</para>
168
178
</refsect1>
169
179
...
...
@@ -179,6 +189,9 @@
179
189
</row>
180
190
</thead>
181
191
<tbody>
192
+
&ldap.changelog.ldap-object;
193
+
&ldap.changelog.return-result-object;
194
+
&ldap.changelog.controls-nullable;
182
195
<row>
183
196
<entry>4.0.5</entry>
184
197
<entry>
...
...
@@ -186,6 +199,12 @@
186
199
See <function>ldap_search</function> for details.
187
200
</entry>
188
201
</row>
202
+
<row>
203
+
<entry>7.3.0</entry>
204
+
<entry>
205
+
Support for <parameter>controls</parameter> added
206
+
</entry>
207
+
</row>
189
208
</tbody>
190
209
</tgroup>
191
210
</informaltable>
...
...
@@ -193,7 +212,6 @@
193
212
</refsect1>
194
213
195
214
</refentry>
196
-
197
215
<!-- Keep this comment at the end of the file
198
216
Local variables:
199
217
mode: sgml
200
218