ldap_list

(PHP 4, PHP 5)

ldap_listRecherche dans un niveau

Description

resource ldap_list ( resource $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 toutefois �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�

// $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] ;
}

Voir aussi