(PHP 4 >= 4.0.4, PHP 5, PHP 7)
ldap_get_option — Get the current value for given option
ldap_get_option ( resource $ldap , int $option [, array|string|int &$value = null ] ) : bool
Sets value
to the value of the specified option.
ldap
An LDAP link identifier, returned by ldap_connect().
option
The parameter option
can be one of:
Option | Type | since |
---|---|---|
LDAP_OPT_DEREF | int | |
LDAP_OPT_SIZELIMIT | int | |
LDAP_OPT_TIMELIMIT | int | |
LDAP_OPT_NETWORK_TIMEOUT | int | |
LDAP_OPT_PROTOCOL_VERSION | int | |
LDAP_OPT_ERROR_NUMBER | int | |
LDAP_OPT_DIAGNOSTIC_MESSAGE | int | |
LDAP_OPT_REFERRALS | int | |
LDAP_OPT_RESTART | int | |
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 | 7.1 |
LDAP_OPT_X_KEEPALIVE_PROBES | int | 7.1 |
LDAP_OPT_X_KEEPALIVE_INTERVAL | int | 7.1 |
LDAP_OPT_X_TLS_CACERTDIR | string | 7.1 |
LDAP_OPT_X_TLS_CACERTFILE | string | 7.1 |
LDAP_OPT_X_TLS_CERTFILE | string | 7.1 |
LDAP_OPT_X_TLS_CIPHER_SUITE | string | 7.1 |
LDAP_OPT_X_TLS_CRLCHECK | int | 7.1 |
LDAP_OPT_X_TLS_CRL_NONE | int | 7.1 |
LDAP_OPT_X_TLS_CRL_PEER | int | 7.1 |
LDAP_OPT_X_TLS_CRL_ALL | int | 7.1 |
LDAP_OPT_X_TLS_CRLFILE | string | 7.1 |
LDAP_OPT_X_TLS_DHFILE | string | 7.1 |
LDAP_OPT_X_TLS_KEYILE | string | 7.1 |
LDAP_OPT_X_TLS_PACKAGE | string | 7.1 |
LDAP_OPT_X_TLS_PROTOCOL_MIN | int | 7.1 |
LDAP_OPT_X_TLS_RANDOM_FILE | string | 7.1 |
LDAP_OPT_X_TLS_REQUIRE_CERT | int |
value
This will be set to the option value.
Returns true
on success or false
on failure.
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.
© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/function.ldap-get-option.php