ldap_set_option

    (PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8)

    ldap_set_option — Modifie la valeur d'une option LDAP

    Description

    ldap_set_option(?LDAP\Connection$ldap, int$option, array|string|int|bool$value): bool

    Modifie la valeur de l'option option en remplaçant la valeur courante par value.

    Liste de paramètres

    ldap

    Soit une instance LDAP\Connection, retournée par ldap_connect(), pour définir l'option pour cette connexion, soit null pour définir l'option globalement.

    option

    Le paramètre option peut prendre l'une des valeurs suivantes :

    OptionTypeDisponible depuis
    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_IDLEintPHP 7.1.0
    LDAP_OPT_X_KEEPALIVE_PROBESintPHP 7.1.0
    LDAP_OPT_X_KEEPALIVE_INTERVALintPHP 7.1.0
    LDAP_OPT_X_TLS_CACERTDIRstringPHP 7.1.0
    LDAP_OPT_X_TLS_CACERTFILEstringPHP 7.1.0
    LDAP_OPT_X_TLS_CERTFILEstringPHP 7.1.0
    LDAP_OPT_X_TLS_CIPHER_SUITEstringPHP 7.1.0
    LDAP_OPT_X_TLS_CRLCHECKintPHP 7.1.0
    LDAP_OPT_X_TLS_CRLFILEstringPHP 7.1.0
    LDAP_OPT_X_TLS_DHFILEstringPHP 7.1.0
    LDAP_OPT_X_TLS_KEYILEstringPHP 7.1.0
    LDAP_OPT_X_TLS_PROTOCOL_MINintPHP 7.1.0
    LDAP_OPT_X_TLS_RANDOM_FILEstringPHP 7.1.0
    LDAP_OPT_X_TLS_REQUIRE_CERTintPHP 7.0.5

    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.

    value

    La nouvelle valeur pour l'option option spécifiée.

    Valeurs de retour

    Cette fonction retourne true en cas de succès ou false si une erreur survient.

    Historique

    VersionDescription
    8.1.0 Le paramètre ldap attend désormais une instance de LDAP\Connection ; auparavant, une ressourceldap link était attendue.

    Exemples

    Exemple #1 Modification de la version du protocole

    <?php
    // $ds doit être une instance de connexion LDAP\Connection 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 instance de connexion LDAP\Connection valide
    $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";
    }
    ?>

    Notes

    Note:

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

    Voir aussi

    To Top