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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
|
<HTML
><HEAD
><TITLE
>ldap_search</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.57"><LINK
REL="HOME"
TITLE="PHP Manual"
HREF="manual.html"><LINK
REL="UP"
TITLE="LDAP functions"
HREF="ref.ldap.html"><LINK
REL="PREVIOUS"
TITLE="ldap_read"
HREF="function.ldap-read.html"><LINK
REL="NEXT"
TITLE="ldap_unbind"
HREF="function.ldap-unbind.html"><META
NAME="HTTP_EQUIV"
CONTENT="text/html; charset=ISO-8859-1"></HEAD
><BODY
CLASS="refentry"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PHP Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.ldap-read.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.ldap-unbind.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.ldap-search"
>ldap_search</A
></H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN19456"
></A
><P
> (PHP3 , PHP4 )</P
>ldap_search -- Search LDAP tree</DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN19459"
></A
><H2
>Description</H2
><DIV
CLASS="funcsynopsis"
><A
NAME="AEN19461"
></A
><P
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <B
CLASS="function"
>ldap_search</B
></CODE
> (int link_identifier, string base_dn, string filter [, array
attributes [, int
attrsonly [, int
sizelimit [, int
timelimit [, int
deref]]]]])</CODE
></P
><P
></P
></DIV
><P
> Returns a search result identifier or false on error.</P
><P
>
<B
CLASS="function"
>ldap_search()</B
> performs the search for a
specified filter on the directory with the scope of
LDAP_SCOPE_SUBTREE. This is equivalent to searching the entire
directory. <TT
CLASS="parameter"
><I
>base_dn</I
></TT
> specifies the base DN
for the directory.</P
><P
> There is a optional fourth parameter, that can be added to
restrict the attributes and values returned by the server to just
those required. This is much more efficient than the default
action (which is to return all attributes and their associated
values). The use of the fourth parameter should therefore be
considered good practice.</P
><P
> The fourth parameter is a standard PHP string array of the
required attributes, eg array("mail","sn","cn") Note that the
"dn" is always returned irrespective of which attributes types
are requested.</P
><P
> Note too that some directory server hosts will be configured to
return no more than a preset number of entries. If this occurs,
the server will indicate that it has only returned a partial
results set. This occurs also if the sixth parameter
<TT
CLASS="parameter"
><I
>sizelimit</I
></TT
> has been used to limit the count
of fetched entries.
</P
><P
> The fifth parameter <TT
CLASS="parameter"
><I
>attrsonly</I
></TT
> should be
set to 1 if only attribute types are wanted.
If set to 0 both attributes types and attribute values are fetched
which is the default behaviour.
</P
><P
> With the sixth parameter <TT
CLASS="parameter"
><I
>sizelimit</I
></TT
> it is
possible to limit the count of entries fetched.
Setting this to 0 means no limit.
NOTE: This parameter can NOT override server-side preset sizelimit.
You can set it lower though.
</P
><P
> The seventh parameter <TT
CLASS="parameter"
><I
>timelimit</I
></TT
> sets the number
of seconds how long is spend on the search.
Setting this to 0 means no limit.
NOTE: This parameter can NOT override server-side preset timelimit.
You can set it lower though.
</P
><P
> The eigth parameter <TT
CLASS="parameter"
><I
>deref</I
></TT
> specifies how aliases
should be handled during the search. It can be one of the following:
<P
></P
><UL
><LI
><P
> LDAP_DEREF_NEVER - (default) aliases are never dereferenced.
</P
></LI
><LI
><P
> LDAP_DEREF_SEARCHING - aliases should be dereferenced during the search
but not when locating the base object of the search.
</P
></LI
><LI
><P
> LDAP_DEREF_FINDING - aliases should be dereferenced when
locating the base object but not during the search.
</P
></LI
><LI
><P
> LDAP_DEREF_ALWAYS - aliases should be dereferenced always.
</P
></LI
></UL
>
</P
><P
> These optional parameters were added in 4.0.2:
<TT
CLASS="parameter"
><I
>attrsonly</I
></TT
>,
<TT
CLASS="parameter"
><I
>sizelimit</I
></TT
>,
<TT
CLASS="parameter"
><I
>timelimit</I
></TT
>,
<TT
CLASS="parameter"
><I
>deref</I
></TT
>.
</P
><P
> The search filter can be simple or advanced, using boolean
operators in the format described in the LDAP doumentation (see
the <A
HREF="http://developer.netscape.com/docs/manuals/directory/41/ag/find.htm"
TARGET="_top"
>Netscape Directory SDK</A
>
for full information on filters).</P
><P
> The example below retrieves the organizational unit, surname,
given name and email address for all people in "My Company" where
the surname or given name contains the substring $person. This
example uses a boolean filter to tell the server to look for
information in more than one attribute.
<TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN19519"
></A
><P
><B
>Example 1. LDAP search</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="programlisting"
> // $ds is a valid link identifier for a directory server
// $person is all or part of a person's name, eg "Jo"
$dn = "o=My Company, c=US";
$filter="(|(sn=$person*)(givenname=$person*))";
$justthese = array( "ou", "sn", "givenname", "mail");
$sr=ldap_search($ds, $dn, $filter, $justthese);
$info = ldap_get_entries($ds, $sr);
print $info["count"]." entries returned<p>";
</PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="function.ldap-read.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="manual.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.ldap-unbind.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>ldap_read</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ref.ldap.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>ldap_unbind</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
|
