reference/ldap/functions/ldap-list.xml
b7cbd468cb4c46d55d43a44cade0eb4590d25dea
b7cbd468cb4c46d55d43a44cade0eb4590d25dea
...
...
@@ -9,15 +9,16 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>resource</type><methodname>ldap_list</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_list</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
...
...
@@ -26,10 +27,11 @@
26
27
<para>
27
28
<constant>LDAP_SCOPE_ONELEVEL</constant> means that the search should only
28
29
return information that is at the level immediately below the
29
-
<parameter>base_dn</parameter> given in the call.
30
+
<parameter>base</parameter> given in the call.
30
31
(Equivalent to typing "<command>ls</command>" and getting a list of files and folders in the
31
32
current working directory.)
32
33
</para>
34
+
&ldap.return-result-array-info;
33
35
</refsect1>
34
36
35
37
<refsect1 role="parameters">
...
...
@@ -37,15 +39,15 @@
37
39
<para>
38
40
<variablelist>
39
41
<varlistentry>
40
-
<term><parameter>link_identifier</parameter></term>
42
+
<term><parameter>ldap</parameter></term>
41
43
<listitem>
42
44
<para>
43
-
An LDAP link identifier, returned by <function>ldap_connect</function>.
45
+
&ldap.parameter.ldap;
44
46
</para>
45
47
</listitem>
46
48
</varlistentry>
47
49
<varlistentry>
48
-
<term><parameter>base_dn</parameter></term>
50
+
<term><parameter>base</parameter></term>
49
51
<listitem>
50
52
<para>
51
53
The base DN for the directory.
...
...
@@ -76,7 +78,7 @@
76
78
</listitem>
77
79
</varlistentry>
78
80
<varlistentry>
79
-
<term><parameter>attrsonly</parameter></term>
81
+
<term><parameter>attributes_only</parameter></term>
80
82
<listitem>
81
83
<para>
82
84
Should be set to 1 if only attribute types are wanted. If set to 0
...
...
@@ -157,6 +159,14 @@
157
159
</para>
158
160
</listitem>
159
161
</varlistentry>
162
+
<varlistentry>
163
+
<term><parameter>controls</parameter></term>
164
+
<listitem>
165
+
<para>
166
+
Array of <link linkend="ldap.controls">LDAP Controls</link> to send with the request.
167
+
</para>
168
+
</listitem>
169
+
</varlistentry>
160
170
</variablelist>
161
171
</para>
162
172
</refsect1>
...
...
@@ -164,7 +174,7 @@
164
174
<refsect1 role="returnvalues">
165
175
&reftitle.returnvalues;
166
176
<para>
167
-
Returns a search result identifier or &false; on error.
177
+
&ldap.return-result-array;
168
178
</para>
169
179
</refsect1>
170
180
...
...
@@ -180,11 +190,13 @@
180
190
</row>
181
191
</thead>
182
192
<tbody>
193
+
&ldap.changelog.ldap-object;
194
+
&ldap.changelog.return-result-object;
195
+
&ldap.changelog.controls-nullable;
183
196
<row>
184
-
<entry>4.0.5</entry>
197
+
<entry>7.3.0</entry>
185
198
<entry>
186
-
Parallel searches support was added. See
187
-
<function>ldap_search</function> for details.
199
+
Support for <parameter>controls</parameter> added
188
200
</entry>
189
201
</row>
190
202
</tbody>
...
...
@@ -201,7 +213,7 @@
201
213
<programlisting role="php">
202
214
<![CDATA[
203
215
<?php
204
-
// $ds is a valid link identifier for a directory server
216
+
// $ds is a valid LDAP\Connection instance for a directory server
205
217
206
218
$basedn = "o=My Company, c=US";
207
219
$justthese = array("ou");
...
...
@@ -230,7 +242,6 @@ for ($i=0; $i < $info["count"]; $i++) {
230
242
</refsect1>
231
243
232
244
</refentry>
233
-
234
245
<!-- Keep this comment at the end of the file
235
246
Local variables:
236
247
mode: sgml
237
248