ldap_get_option

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

    ldap_get_option — Get the current value for given option

    Description

    ldap_get_option(LDAP\Connection $ldap, int $option, array|string|int &$value = null): bool

    Sets value to the value of the specified option.

    Return Values

    Returns true on success or false on failure.

    Changelog

    Version Description
    8.1.0 The ldap parameter expects an LDAP\Connection instance now; previously, a valid ldap link resource was expected.

    Examples

    Example #1 Check protocol version

    <?php
    // $ds is a valid LDAP\Connection instance 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";
    }
    ?>

    Notes

    Note:

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

    See Also

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 3 notes

    up
    9
    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
    0
    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
    To Top