ldap_set_option

(PHP 4 >= 4.0.4, PHP 5)

ldap_set_optionModifie la valeur d'une option LDAP

Description

bool ldap_set_option ( resource $link_identifier , int $option , mixed $newval )

Modifie la valeur de l'option option en rempla�ant la valeur courante par newval .

Liste de param�tres

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.

Valeurs de retour

Cette fonction retourne TRUE en cas de succ�s, FALSE en cas d'�chec.

Exemples

Exemple #1 Modification de la version du protocole

<?php
// $ds doit �tre une ressource de connexion valide
if (ldap_set_option($dsLDAP_OPT_PROTOCOL_VERSION3)) {
    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($dsLDAP_OPT_SERVER_CONTROLS, array($ctrl1$ctrl2))) {
    echo 
"Impossible de modifier les contr�les du serveur";
}
?>

Notes

Note: Cette fonction n'est disponible que lorsque vous utilisez OpenLDAP 2.x.x ou Netscape Directory SDK x.x.

Voir aussi