(PHP 4, PHP 5, PHP 7)
ldap_read — Lit une entrée
$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 la configuration
LDAP_SCOPE_BASE
. C'est équivalent à lire une
entrée dans un dossier.
link_identifier
Un identifiant de lien LDAP, retourné par la fonction ldap_connect().
base_dn
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.
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.
Retourne un identifiant de résultat de recherche, ou FALSE
si une erreur survient.
Version | Description |
---|---|
4.0.5 | Les recherches parallèles ont été ajoutées. Voir la fonction ldap_search() pour plus de détails. |