ldap_list
(PHP 4, PHP 5)
ldap_list — Recherche dans un niveau
Description
$link_identifier
, string $base_dn
, string $filter
[, array $attributes
[, int $attrsonly
[, int $sizelimit
[, int $timelimit
[, int $deref
]]]]] )
Effectue une recherche avec le filtre filter
dans le dossier base_dn avec l'option
LDAP_SCOPE_ONELEVEL.
LDAP_SCOPE_ONELEVEL signifie que la recherche
ne peut retourner des entrées que dans le niveau qui est immédiatement
sous le niveau base_dn (c'est l'équivalent
de la commande ls, pour obtenir la liste des fichiers et dossiers
du dossier courant).
Liste de paramètres
-
link_identifier -
Un identifiant de lien LDAP, retourné par la fonction ldap_connect().
-
base_dn -
La base DN du dossier.
-
filter -
-
attributes -
Un tableau d'attributs requis, e.g. array("mail", "sn", "cn"). Notez que le "dn" est toujours retourné, quelque 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é comme une bonne pratique.
-
attrsonly -
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 -
Vous 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. Vous pouvez cependant 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 si vous utilisez 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 vous pouvez l'utiliser pour être plus restrictif.
-
deref -
Spécifie le nombre d'alias qui 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.
-
Valeurs de retour
Retourne un identifiant de résultats pour la recherche, ou FALSE
si une erreur survient.
Historique
| Version | Description |
|---|---|
| 4.0.5 | Les recherches parallèles ont été ajoutées. Voir la fonction ldap_search() pour plus de détails. |
| 4.0.2 |
Les paramètres attrsonly, sizelimit,
timelimit et deref ont été
ajoutés.
|
Exemples
Exemple #1 Produit une liste de tous les services d'une société
<?php
// $ds doit être une ressource de connexion valide
$basedn = "o=My Company, c=US";
$justthese = array("ou");
$sr = ldap_list($ds, $basedn, "ou=*", $justthese);
$info = ldap_get_entries($ds, $sr);
for ($i=0; $i < $info["count"]; $i++) {
echo $info[$i]["ou"][0];
}
?>