ldap_set_option
ldap_set_option
(PHP 4 >= 4.0.4, PHP 5, PHP 7)
ldap_set_option — Set the value of the given option
Description
bool ldap_set_option ( resource $link_identifier , int $option , mixed $newval )
Sets the value of the specified option to be newval
.
Parameters
-
link_identifier
-
An LDAP link identifier, returned by ldap_connect().
-
option
-
The parameter
option
can be one of:Option Type Available since LDAP_OPT_DEREF
integer LDAP_OPT_SIZELIMIT
integer LDAP_OPT_TIMELIMIT
integer LDAP_OPT_NETWORK_TIMEOUT
integer PHP 5.3.0 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_DIAGNOSTIC_MESSAGE
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_PROTOCOL_MIN
integer LDAP_OPT_X_TLS_RANDOM_FILE
string LDAP_OPT_X_TLS_REQUIRE_CERT
integer PHP 7.1.0 LDAP_OPT_SERVER_CONTROLS
andLDAP_OPT_CLIENT_CONTROLS
require a list of controls, this means that the value must be an array of controls. A control consists of an oid identifying the control, an optional value, and an optional flag for criticality. In PHP a control is given by an array containing an element with the key oid and string value, and two optional elements. The optional elements are key value with string value and key iscritical with boolean value. iscritical defaults toFALSE
if not supplied. See » draft-ietf-ldapext-ldap-c-api-xx.txt for details. See also the second example below. -
newval
-
The new value for the specified
option
.
Return Values
Returns TRUE
on success or FALSE
on failure.
Examples
Example #1 Set protocol version
<?php // $ds is a valid link identifier for a directory server if (ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3)) { echo "Using LDAPv3"; } else { echo "Failed to set protocol version to 3"; } ?>
Example #2 Set server controls
<?php // $ds is a valid link identifier for a directory server // control with no value $ctrl1 = array("oid" => "1.2.752.58.10.1", "iscritical" => true); // iscritical defaults to FALSE $ctrl2 = array("oid" => "1.2.752.58.1.10", "value" => "magic"); // try to set both controls if (!ldap_set_option($ds, LDAP_OPT_SERVER_CONTROLS, array($ctrl1, $ctrl2))) { echo "Failed to set server controls"; } ?>
Notes
Note:
This function is only available when using OpenLDAP 2.x.x OR Netscape Directory SDK x.x.
See Also
- ldap_get_option() - Get the current value for given option
© 1997–2017 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://secure.php.net/manual/en/function.ldap-set-option.php