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 — Recherche sur le serveur LDAP
$ldap,$base,$filter,$attributes = [],$attributes_only = 0,$sizelimit = -1,$timelimit = -1,$deref = LDAP_DEREF_NEVER,$controls = null
Effectue une recherche avec le filtre filter dans le
dossier base avec le paramétrage
LDAP_SCOPE_SUBTREE. C'est l'équivalent
d'une recherche dans le dossier.
Il est également possible d'effectuer des recherches parallèles. Dans ce cas, le premier argument doit être un tableau des
instances de LDAP\Connection, plutôt qu'une seule.
Si les recherches ne devraient pas utiliser le même nom distingué (DN) de base et filtre, un tableau de DN de base et/ou un tableau de filtre peuvent être passé comme arguments à la place.
Ces tableaux doivent être de la même taille que le tableau des instances de LDAP\Connection,
puisque les premières entrées des tableaux sont utilisées pour une recherche, les secondes pour une autre, et ainsi de suite.
Lors de recherches parallèles, un tableau des instances de LDAP\Result est retourné, sauf en cas d'erreur, où la valeur de retour sera false.
ldapUne instance LDAP\Connection, retourné par ldap_connect().
baseLa base DN pour le dossier.
filterLe filtre de recherche peut être simple ou avancé, et utiliser ces opérateurs booléens au format décrit dans la documentation LDAP (se reporter à » Netscape Directory SDK ou » RFC4515 pour plus d'informations sur les filtres).
attributes
Un tableau d'attributs requis, p. ex. array("mail", "sn", "cn").
À noter que le "dn" est toujours retourné, quel que soit le type de l'attribut
demandé.
L'utilisation de ce paramètre est plus efficace que l'action par défaut (qui est de retourner tous les attributs ainsi que leurs valeurs associées). L'utilisation de ce paramètre doit pour cette raison être considérée comme une bonne pratique.
attributes_only
Doit être défini à 1 si seuls les types des attributs sont demandés.
S'il est défini à 0, les types et les valeurs des attributs sont récupérés,
ce qui correspond au comportement par défaut.
sizelimit
Permet de limiter le nombre d'entrées à récupérer. Le fait
de définir ce paramètre à 0 signifie qu'il n'y aura aucune limite.
Note:
Ce paramètre ne peut pas écraser la configuration côté serveur. Il est cependant possible de positionner une valeur inférieure.
Quelques dossiers serveurs peuvent être configurés afin de ne retourner qu'un nombre d'entrées données. Si ce comportement survient, le serveur indique qu'il n'a retourné qu'un jeu de résultats partiel. Ce comportement intervient également lors de l'utilisation de ce paramètre pour limiter le nombre d'entrées récupérées.
timelimit
Définit le nombre maximal de secondes permis pour la recherche.
Le fait de définir ce paramètre à 0 signifie qu'il n'y a pas de limite.
Note:
Ce paramètre ne peut pas écraser la configuration côté serveur, mais il est possible de l'utiliser pour être plus restrictif.
derefSpécifie comment les alias doivent être gérés pendant la recherche. Il peut être un parmi les suivants :
LDAP_DEREF_NEVER - (défaut) les alias ne sont jamais déréférencés.
LDAP_DEREF_SEARCHING - les alias doivent être déréférencés
pendant la recherche mais pas lors de la localisation de l'objet de base de la recherche.
LDAP_DEREF_FINDING - les alias doivent être déréférencés
lors de la localisation de l'objet de base mais pas durant la recherche.
LDAP_DEREF_ALWAYS - les alias doivent toujours être
déréférencés.
controlsTableau de Contrôles LDAP à envoyer avec la requête.
Retourne une instance de LDAP\Result, un tableau des instances de LDAP\Result, ou false si une erreur survient.
| Version | Description |
|---|---|
| 8.1.0 |
Le paramètre ldap attend désormais une instance de
LDAP\Connection ; auparavant, une resource ldap link était attendue.
|
| 8.1.0 | Retourne désormais une instance de LDAP\Result ; auparavant, une resource était attendu. |
| 8.0.0 |
controls est désormais nullable ; auparavant, sa valeur par défaut était [].
|
| 7.3.0 |
Le support de controls a été ajouté.
|
L'exemple ci-dessous lit le nom du service, le nom, le prénom et l'email des employés de la société "Ma Compagnie", dont le nom ou le prénom contient la sous-chaîne : $person. Cet exemple illustre l'utilisation de filtres pour indiquer au serveur de faire une recherche sur deux attributs.
Exemple #1 Recherche LDAP
<?php
// $ds est une instance de connexion LDAP\Connection valide pour un serveur d'annuaire.
// $person est un nom ou une partie de nom (par exemple, "Jean")
$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"]." entrées retournées\n";
?>