(PHP 4 >= 4.0.4, PHP 5, PHP 7)
ldap_get_option — Get the current value for given option
Sets retval to the value of the specified option.
link_identifierAn LDAP link identifier, returned by ldap_connect().
option
The parameter option can be one of:
| Option | Type | since |
|---|---|---|
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_DIAGNOSTIC_MESSAGE |
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 | 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 |
integer | 7.1 |
LDAP_OPT_X_TLS_CRL_NONE |
integer | 7.1 |
LDAP_OPT_X_TLS_CRL_PEER |
integer | 7.1 |
LDAP_OPT_X_TLS_CRL_ALL |
integer | 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 |
integer | 7.1 |
LDAP_OPT_X_TLS_RANDOM_FILE |
string | 7.1 |
LDAP_OPT_X_TLS_REQUIRE_CERT |
integer |
retvalThis 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.