ldap_search

ldap_search

Search LDAP tree

 **ldap_search**  $ldap  $base  $filter array $attributes int $attributes_only int $sizelimit int $timelimit int $deref  $controls

Performs the search for a specified filter on the directory with the scope of . This is equivalent to searching the entire directory. LDAP_SCOPE_SUBTREE

ldapldap.parameter.ldap

baseThe base DN for the directory.

filter The search filter can be simple or advanced, using boolean operators in the format described in the LDAP documentation (see the or for full information on filters). Netscape Directory SDKRFC4515

attributes An array of the required attributes, e.g. . Note that the "dn" is always returned irrespective of which attributes types are requested. array("mail", "sn", "cn")

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.

Opmerking: > 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.

Opmerking: > This parameter can NOT override server-side preset timelimit. You can set it lower though.

deref Specifies how aliases should be handled during the search. It can be one of the following:

  - - (default) aliases are never           dereferenced.          `LDAP_DEREF_NEVER`

• • aliases should be dereferenced during the search but not when locating the base object of the search. LDAP_DEREF_SEARCHING
• • aliases should be dereferenced when locating the base object but not during the search. LDAP_DEREF_FINDING
• • aliases should be dereferenced always. LDAP_DEREF_ALWAYS

controls Array of to send with the request. LDAP Controls

ldap.return-result-array

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 . This example uses a boolean filter to tell the server to look for information in more than one attribute.

$personVoorbeeld: 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";
?>