PHP is developed and maintained by a global community of contributors.
The PHP Foundation helps fund this work. If PHP is part of your business or projects, consider sponsoring the Foundation.
(PHP 4, PHP 5, PHP 7, PHP 8)
ldap_search — Search LDAP tree
$ldap,$base,$filter,$attributes = [],$attributes_only = 0,$sizelimit = -1,$timelimit = -1,$deref = LDAP_DEREF_NEVER,$controls = null
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.
Також можливо шукати паралельно.
Тоді перший параметр має бути масивом примірників
LDAP\Connection. Якщо пошуковики мають використовувати
різні базові DN і фільтр, то небхідно передати масив базових DN і/або
масив фільтрів, як параметри. Ці масиви мають бути однакових розмірів з масивом
примірників LDAP\Connection, оскільки перші елементи
масивів використовуються для одного пошуку, другі використовуються для іншого і
так далі. Виконавши паралельний пошук, повернеться масив примірників
LDAP\Result, окрім випадків помилок, коли значення, що
повернеться, буде false.
ldapПримірник LDAP\Connection, якого повертає ldap_connect().
baseThe base DN for the directory.
filterThe search filter can be simple or advanced, using boolean operators in the format described in the LDAP documentation (see the » Netscape Directory SDK or » RFC4515 for full information on filters).
attributes
An array of the required attributes, e.g. array("mail", "sn", "cn").
Note that the "dn" is always returned irrespective of which attributes
types are requested.
Using this parameter is much more efficient than the default action (which is to return all attributes and their associated values). The use of this parameter should therefore be considered good practice.
attributes_onlyShould 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.
sizelimitEnables you to limit the count of entries fetched. Setting this to 0 means no limit.
Зауваження:
This parameter can NOT override server-side preset sizelimit. You can set it lower though.
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 also occurs if you use this parameter to limit the count of fetched entries.
timelimitSets the number of seconds how long is spend on the search. Setting this to 0 means no limit.
Зауваження:
This parameter can NOT override server-side preset timelimit. You can set it lower though.
derefSpecifies how aliases should be handled during the search. It can be one of the following:
LDAP_DEREF_NEVER - (default) aliases are never
dereferenced.
LDAP_DEREF_SEARCHING - aliases should be
dereferenced during the search but not when locating the base object
of the search.
LDAP_DEREF_FINDING - aliases should be
dereferenced when locating the base object but not during the search.
LDAP_DEREF_ALWAYS - aliases should be dereferenced
always.
controlsArray of LDAP Controls to send with the request.
Повертає примірника LDAP\Result, масив примірників
LDAP\Result, або false в разі помилки.
| Версія | Опис |
|---|---|
| 8.1.0 |
Тепер параметр ldap має бути примірником
LDAP\Connection; раніше очікувався дійсний resource
ldap link.
|
| 8.1.0 | Тепер повертає примірника LDAP\Result; раніше повертався resource. |
| 8.0.0 |
Параметр controls тепер може бути null; раніше
початково було [].
|
| 7.3.0 |
Support for controls added
|
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.
Приклад #1 LDAP search
<?php
// $ds is a valid LDAP\Connection instance 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);
echo $info["count"]." entries returned\n";
?>