ldap_set_option
(PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8)
ldap_set_option — Setzt den Wert der gegebenen Option
Beschreibung
Setzt den Wert der angegebenen Option auf value.
Parameter-Liste
-
ldap -
Entweder eine von ldap_connect() zurückgegebene LDAP\Connection-Instanz, um die Option für diese Verbindung zu setzen, oder
null, um die Option global zu setzen. -
option -
Der Parameter
optionkann einer der folgenden Werte sein:Option Typ Verfügbar seit LDAP_OPT_DEREFint LDAP_OPT_SIZELIMITint LDAP_OPT_TIMELIMITint LDAP_OPT_NETWORK_TIMEOUTint LDAP_OPT_PROTOCOL_VERSIONint LDAP_OPT_ERROR_NUMBERint LDAP_OPT_REFERRALSbool LDAP_OPT_RESTARTbool LDAP_OPT_HOST_NAMEstring LDAP_OPT_ERROR_STRINGstring LDAP_OPT_DIAGNOSTIC_MESSAGEstring LDAP_OPT_MATCHED_DNstring LDAP_OPT_SERVER_CONTROLSarray LDAP_OPT_CLIENT_CONTROLSarray LDAP_OPT_X_KEEPALIVE_IDLEint PHP 7.1.0 LDAP_OPT_X_KEEPALIVE_PROBESint PHP 7.1.0 LDAP_OPT_X_KEEPALIVE_INTERVALint PHP 7.1.0 LDAP_OPT_X_TLS_CACERTDIRstring PHP 7.1.0 LDAP_OPT_X_TLS_CACERTFILEstring PHP 7.1.0 LDAP_OPT_X_TLS_CERTFILEstring PHP 7.1.0 LDAP_OPT_X_TLS_CIPHER_SUITEstring PHP 7.1.0 LDAP_OPT_X_TLS_CRLCHECKint PHP 7.1.0 LDAP_OPT_X_TLS_CRLFILEstring PHP 7.1.0 LDAP_OPT_X_TLS_DHFILEstring PHP 7.1.0 LDAP_OPT_X_TLS_KEYFILEstring PHP 7.1.0 LDAP_OPT_X_TLS_PROTOCOL_MINint PHP 7.1.0 LDAP_OPT_X_TLS_RANDOM_FILEstring PHP 7.1.0 LDAP_OPT_X_TLS_REQUIRE_CERTint PHP 7.0.5 Die Optionen
LDAP_OPT_SERVER_CONTROLSundLDAP_OPT_CLIENT_CONTROLSbenötigen eine Liste von Steuerelementen, d. h. der Wert muss ein Array aus Steuerelementen sein. Ein Steuerelement besteht aus einer OID, die das Steuerelement identifiziert, einem optionalen Wert, und einem optionalen Kennzeichen für die Kritikalität. Bei PHP wird ein Steuerelement durch ein Array angegeben. Dieses Array enthält ein Element mit dem Schlüssel oid und einer Zeichenkette als Wert und zwei optionale Elemente. Die optionalen Elemente sind die Schlüssel value mit einer Zeichenkette als Wert und iscritical mit einem booleschen Wert. Der vorgegebene Wert von iscritical istfalse, falls nicht angegeben. Siehe » draft-ietf-ldapext-ldap-c-api-xx.txt für Details. Ebenso ist das zweite Beispiel weiter unten zu konsultieren. -
value -
Der neue Wert für die angegebene
option.
Rückgabewerte
Gibt bei Erfolg true zurück. Bei einem Fehler wird false zurückgegeben.
Changelog
| Version | Beschreibung |
|---|---|
| 8.1.0 |
Der Parameter ldap erwartet nun eine LDAP\Connection-Instanz; vorher wurde eine Ressource
erwartet.
|
Beispiele
Beispiel #1 Setzen der Protokollversion
<?php
// $ds ist eine gültige LDAP\Connection-Instanz für einen Verzeichnis-Server
if (ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3))
echo "Verwenden von LDAPv3";
} else {
echo "Kann das Protokoll nicht auf Version 3 setzen";
}
?>
Beispiel #2 Setzen der Server-Steuerelemente
<?php
// $ds ist eine gültige LDAP\Connection-Instanz für einen Verzeichnis-Server
// Steuerelement ohne Wert
$ctrl1 = array("oid" => "1.2.752.58.10.1", "iscritical" => true);
// iscritical hat den vorgegebenen Wert FALSE
$ctrl2 = array("oid" => "1.2.752.58.1.10", "value" => "magic");
// Versuch, beide Steuerelemente zu setzen
if (!ldap_set_option($ds, LDAP_OPT_SERVER_CONTROLS, array($ctrl1, $ctrl2))) {
echo "Kann die Server-Steuerelemente nicht setzen";
}
?>
Anmerkungen
Hinweis:
Diese Funktion steht nur zur Verfügung, wenn OpenLDAP 2.x.x ODER Netscape Directory SDK x.x verwendet wird.
