ldap_read
(PHP 4, PHP 5, PHP 7, PHP 8)
ldap_read — Lit une entrée
Description
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
.
Liste de paramètres
ldap
-
Une instance LDAP\Connection, retourné par
ldap_connect().
base
-
La base DN du dossier.
filter
-
Un filtre ne peut être vide. Si vous voulez lire toutes les informations
d'une entrée, utilisez le filtre "objectClass=*
".
Si vous savez quels sont les types qui sont utilisés dans le serveur de
dossiers, vous pouvez aussi utiliser un filtre approprié, comme
"objectClass=inetOrgPerson
".
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.
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
-
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.
controls
-
Tableau de Contrôles LDAP à envoyer avec la requête.