Edit Report a Bug

    ldap_get_option

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

    ldap_get_option — Get the current value for given option

    설명

    bool ldap_get_option ( resource $link_identifier , int $option , mixed &$retval )

    Sets retval to the value of the specified option.

    인수

    link_identifier

    An LDAP link identifier, returned by ldap_connect().

    option

    The parameter option can be one of:

    Option Type
    LDAP_OPT_DEREF integer
    LDAP_OPT_SIZELIMIT integer
    LDAP_OPT_TIMELIMIT integer
    LDAP_OPT_NETWORK_TIMEOUT integer
    LDAP_OPT_PROTOCOL_VERSION integer
    LDAP_OPT_ERROR_NUMBER integer
    LDAP_OPT_REFERRALS bool
    LDAP_OPT_RESTART bool
    LDAP_OPT_HOST_NAME string
    LDAP_OPT_ERROR_STRING string
    LDAP_OPT_MATCHED_DN string
    LDAP_OPT_SERVER_CONTROLS array
    LDAP_OPT_CLIENT_CONTROLS array
    LDAP_OPT_X_KEEPALIVE_IDLE int  
    LDAP_OPT_X_KEEPALIVE_PROBES int  
    LDAP_OPT_X_KEEPALIVE_INTERVAL int  
    LDAP_OPT_X_TLS_CACERTDIR string  
    LDAP_OPT_X_TLS_CACERTFILE string  
    LDAP_OPT_X_TLS_CERTFILE string  
    LDAP_OPT_X_TLS_CIPHER_SUITE string  
    LDAP_OPT_X_TLS_CRLCHECK integer  
    LDAP_OPT_X_TLS_CRLFILE string  
    LDAP_OPT_X_TLS_DHFILE string  
    LDAP_OPT_X_TLS_KEYILE string  
    LDAP_OPT_X_TLS_PACKAGE string  
    LDAP_OPT_X_TLS_PROTOCOL_MIN integer  
    LDAP_OPT_X_TLS_RANDOM_FILE string  
    LDAP_OPT_X_TLS_REQUIRE_CERT integer  

    retval

    This will be set to the option value.

    반환값

    성공 시 TRUE를, 실패 시 FALSE를 반환합니다.

    예제

    Example #1 Check protocol version

    <?php
    // $ds is a valid link identifier for a directory server
    if (ldap_get_option($ds, LDAP_OPT_PROTOCOL_VERSION, $version)) {
        echo     "Using protocol version $version\n";
    } else {
        echo     "Unable to determine protocol version\n";
    }
    ?>

    주의

    Note:

    This function is only available when using OpenLDAP 2.x.x OR Netscape Directory SDK x.x.

    참고

    add a note add a note

    User Contributed Notes 3 notes

    up
    8
    Anonymous
    8 years ago
    Following on from Jeremy S's example.
    Instead of defining LDAP_OPT_DIAGNOSTIC_MESSAGE as 0x32 then using it, you can just use the option already defined as that value :)

    LDAP_OPT_ERROR_STRING
    up
    6
    Jeremy S
    11 years ago
    Here is how to tell if an Active Directory user account expired:

    define('LDAP_OPT_DIAGNOSTIC_MESSAGE', 0x0032);

    ldap_set_option($conn, LDAP_OPT_PROTOCOL_VERSION, 3);
    ldap_set_option($conn, LDAP_OPT_REFERRALS, 0);

    $bind = ldap_bind($conn, $user, $pass);

    ldap_get_option($conn, LDAP_OPT_DIAGNOSTIC_MESSAGE, $extended_error);

    if (!empty($extended_error))
    {
        $errno = explode(',', $extended_error)[2];
        $errno = explode(' ', $errno)[2];
        $errno = intval($errno);

        if ($errno == 532)
            $err = 'Unable to login: Password expired.';
    }
    up
    1
    Maarten
    4 years ago
    PHP 7.1 added support for configuring the LDAP CA/Cert environment directly, rather than relying on the environment variables. I noticed that a lot of people are having trouble getting this to work.

    The correct way is:
    $ds=ldap_connect("ldap.google.com"); 
    ldap_set_option(NULL, LDAP_OPT_X_TLS_CERTFILE, "/path/file.crt");
    ldap_set_option(NULL, LDAP_OPT_X_TLS_KEYFILE, "/path/file.key");
    ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3);
    ldap_set_option($ds, LDAP_OPT_REFERRALS, 0);
    ldap_start_tls($ds);
    ...
    ldap_close($ds);
    add a note add a note
    To Top