(PHP 4, PHP 5, PHP 7)
ldap_read — Lies einen Eintrag
$link_identifier
, string $base_dn
, string $filter
[, array $attributes = array("*")
[, int $attrsonly = 0
[, int $sizelimit = -1
[, int $timelimit = -1
[, int $deref = LDAP_DEREF_NEVER
[, array $serverctrls = array()
]]]]]] ) : resource
Führt eine Suche nach dem angegeben filter im
Verzeichnis mit dem Geltungsbereich LDAP_SCOPE_BASE
durch. Somit ist es gleichwertig zum Lesen eines Eintrags aus dem
Verzeichnis.
link_identifierEine LDAP-Verbindungskennung, geliefert von ldap_connect().
base_dnDer Basis-DN für das Verzeichnis.
filter
Ein leerer Filter ist nicht erlaubt. Soll die gesamte Information zu
einem Eintrag ermittelt werden, ist ein objectClass=*
Filter zu verwenden. Wenn bekannt ist, welche Eintragstypen auf dem
Verzeichnisserver verwendet werden, könnte ein entsprechender Filter, wie
objectClass=inetOrgPerson verwendet werden.
attributesEin Array von erforderlichen Merkmalen, z.B. array("mail", "sn", "cn"). Es ist zu beachten, dass der "dn" immer zurückgegeben wird, unabhängig davon, welche Merkmalstypen angefordert wurden.
Die Verwendung dieses Parameters ist effizienter als die Standardaktion (die alle Merkmale und deren assoziierte Werte zurückgibt). Die Verwendung dieses Parameter sollte daher als gute Praxis eingestuft werden.
attrsonlySollte auf 1 gesetzt werden, wenn nur Merkmalstypen erwünscht sind. Wird 0 übergeben, werden sowohl Merkmalstypen als auch Merkmalswerte abgerufen, was das Standardverhalten ist.
sizelimitErmöglich die Begrenzung der Anzahl der abgerufenen Einträge. Wird hier 0 übergeben, besteht keine Begrenzung.
Hinweis:
Dieser Parameter kann ein serverseitig voreingestelltes sizelimit nicht übersteuern. Es kann allerdings kleiner gewählt werden.
Verzeichnisserver können so konfiguriert werden, dass sie nicht mehr als eine voreingestellte Anzahl von Einträgen liefern. Wenn dies geschieht, dann wird der Server anzeigen, dass nur eine teilweise Ergebnismenge zurückgeliefert wurde. Das geschieht ebenfalls, wenn dieser Parameter verwendet wird, um die Zahl der abgerufenen Einträge zu begrenzen.
timelimitSetzt die Anzahl von Sekunden, die auf die Suche verwendet wird. Die Übergabe von 0 bedeutet keine Begrenzung.
Hinweis:
Dieser Parameter kann ein serverseitig voreingestelltes timelimit nicht übersteuern. Es kann allerdings kleiner gewählt werden.
derefGibt an, wie Aliase während der Suche behandelt werden sollen. Es kann einen der folgenden Werte annehmen:
LDAP_DEREF_NEVER - (standard) Aliase werden nie
dereferenziert.
LDAP_DEREF_SEARCHING - Aliase sollen während der
Suche dereferenziert werden, aber nicht wenn das Basis-Objekt der
Suche lokalisiert wird.
LDAP_DEREF_FINDING - Aliase sollen für die
Lokalisierung des Basis-Objekt dereferenziert werden, aber nicht
während der Suche.
LDAP_DEREF_ALWAYS - Aliase sollen immer
dereferenziert werden.
serverctrlsArray von LDAP-Steuerbefehlen, die mit der Anfrage versendet werden sollen.
Gibt eine Suchergebniskennung zurück, oder FALSE im Fehlerfall.
| Version | Beschreibung |
|---|---|
| 4.0.5 | Unterstützung für parallele Suchen wurde hinzugefügt. Siehe ldap_search() für Details. |
| 7.3 |
Unterstützung für serverctrls hinzugefügt.
|