ldap_set_option

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

    ldap_set_option — Establecer el valor de la opción proporcionada

    Descripción

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

    Establece el valor de la opción especificada a newval.

    Parámetros

    link_identifier

    Un identificador de enlace de LDAP, devuelto por ldap_connect().

    option

    El parámetro option puede ser uno de estos:

    OptionTypeAvailable since
    LDAP_OPT_DEREFinteger 
    LDAP_OPT_SIZELIMITinteger 
    LDAP_OPT_TIMELIMITinteger 
    LDAP_OPT_NETWORK_TIMEOUTintegerPHP 5.3.0
    LDAP_OPT_PROTOCOL_VERSIONinteger 
    LDAP_OPT_ERROR_NUMBERinteger 
    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_CERTFILEPHP 7.1.0 
    LDAP_OPT_X_TLS_CIPHER_SUITEstringPHP 7.1.0
    LDAP_OPT_X_TLS_CRLCHECKintegerPHP 7.1.0
    LDAP_OPT_X_TLS_CRLFILEstringPHP 7.1.0
    LDAP_OPT_X_TLS_DHFILEstringPHP 7.1.0
    LDAP_OPT_X_TLS_KEYFILEstringPHP 7.1.0
    LDAP_OPT_X_TLS_PROTOCOL_MINintegerPHP 7.1.0
    LDAP_OPT_X_TLS_RANDOM_FILEstringPHP 7.1.0
    LDAP_OPT_X_TLS_REQUIRE_CERTintegerPHP 7.0.5

    LDAP_OPT_SERVER_CONTROLS y LDAP_OPT_CLIENT_CONTROLS solicitan una lista de controles, lo que significa que el valor debe ser un array de controles. Un control consiste en un oid identificando el control, un value opcional, y un indicador opcional representado por criticality. En PHP un control es proporcionado por un array que contiene un elemento con la clave oid, una cadena de valor, y dos elementos opcionales. Los elementos opcionales son la clave value con un valor de tipo cadena, y la clave iscritical con un valor de tipo booleano. El valor de la clave iscritical de forma predeterminada es false si no es provisto. Vea » draft-ietf-ldapext-ldap-c-api-xx.txt para más detalles. Vea también el segundo ejemplo a continuación.

    newval

    El nuevo valor para el option especificado.

    Valores devueltos

    Devuelve true en caso de éxito o false en caso de error.

    Ejemplos

    Ejemplo #1 Establecer la versión del protocolo

    <?php
    // $ds es un identificador de enlace válido para un servidor de directorio
    if (ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3)) {
    echo     "Utilizando LDAPv3";
    } else {
    echo     "Falló al establcer la versión 3 del protocolo";
    }
    ?>

    Ejemplo #2 Establecer controles del servidor

    <?php
    // $ds es un identificador de enlace válido para un servidor de directorio
    // control sin valor
    $ctrl1 = array("oid" => "1.2.752.58.10.1", "iscritical" => true);
    // iscritical de forma predeterminada está en FALSE
    $ctrl2 = array("oid" => "1.2.752.58.1.10", "value" => "magic");
    // intentar establecer ambos controles
    if (!ldap_set_option($ds, LDAP_OPT_SERVER_CONTROLS, array($ctrl1, $ctrl2))) {
    echo     "Falló al establecer los controles del servidor";
    }
    ?>

    Notas

    Nota:

    Esta función está disponible solamente cuando se utiliza OpenLDAP 2.x.x ó Netscape Directory SDK x.x.

    Ver también

    To Top