(PHP 4 >= 4.0.4, PHP 5)
ldap_set_option — Modifie la valeur d'une option LDAP
Modifie la valeur de l'option option en remplaçant la valeur
courante par newval.
link_identifier
Un identifiant de lien LDAP, retourné par la fonction ldap_connect().
option
Le paramètre option peut prendre l'une des valeurs suivantes :
| Option | Type | Disponible depuis |
|---|---|---|
LDAP_OPT_DEREF |
entier | |
LDAP_OPT_SIZELIMIT |
entier | |
LDAP_OPT_TIMELIMIT |
entier | |
LDAP_OPT_NETWORK_TIMEOUT |
entier | PHP 5.3.0 |
LDAP_OPT_PROTOCOL_VERSION |
entier | |
LDAP_OPT_ERROR_NUMBER |
entier | |
LDAP_OPT_REFERRALS |
booléen | |
LDAP_OPT_RESTART |
booléen | |
LDAP_OPT_HOST_NAME |
chaîne de caractères | |
LDAP_OPT_ERROR_STRING |
chaîne de caractères | |
LDAP_OPT_MATCHED_DN |
chaîne de caractères | |
LDAP_OPT_SERVER_CONTROLS |
tableau | |
LDAP_OPT_CLIENT_CONTROLS |
tableau |
Les options LDAP_OPT_SERVER_CONTROLS et
LDAP_OPT_CLIENT_CONTROLS requièrent une
liste de contrôles, ce qui signifie que la valeur doit être un tableau de contrôles.
Un contrôle est constitué d'un oid
l'identifiant, une valeur optionnelle value,
et un flag optionnel de "criticalité" (criticality). En PHP,
un contrôle est défini sous la forme d'un tableau, donc les clés sont
oid avec une chaîne comme valeur, et deux clés
optionnelles. Ces clés sont value avec une
chaîne comme valeur, et iscritical avec une valeur
booléenne. Par défaut, iscritical vaut FALSE. Voir
le fichier » draft-ietf-ldapext-ldap-c-api-xx.txt
pour plus de détails. Reportez-vous au second exemple pour une illustration.
newval
La nouvelle valeur pour l'option option spécifiée.
Cette fonction retourne TRUE en cas de
succès ou FALSE si une erreur survient.
Exemple #1 Modification de la version du protocole
<?php
// $ds doit être une ressource de connexion valide
if (ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3)) {
echo "Version LDAPv3";
} else {
echo "Impossible de modifier la version du protocole à 3";
}
?>
Exemple #2 Modification des contrôles du serveur
<?php
// $ds doit être une ressource de connexion valide de
// contrôle sans valeur
$ctrl1 = array("oid" => "1.2.752.58.10.1", "iscritical" => true);
// iscritical vaut par défaut FALSE
$ctrl2 = array("oid" => "1.2.752.58.1.10", "value" => "magic");
// tente d'utiliser les deux contrôles
if (!ldap_set_option($ds, LDAP_OPT_SERVER_CONTROLS, array($ctrl1, $ctrl2))) {
echo "Impossible de modifier les contrôles du serveur";
}
?>
Note:
Cette fonction n'est disponible que lorsque vous utilisez OpenLDAP 2.x.x ou Netscape Directory SDK x.x.