ldap_set_optionSet the value of the given option
&reftitle.description;
boolldap_set_optionresourcenullldapintoptionarraystringintboolvalue
Sets the value of the specified option to be value.
&reftitle.parameters;
ldap
An LDAP link identifier, returned by ldap_connect.
option
The parameter option can be one of:
OptionTypeAvailable sinceLDAP_OPT_DEREFintLDAP_OPT_SIZELIMITintLDAP_OPT_TIMELIMITintLDAP_OPT_NETWORK_TIMEOUTintLDAP_OPT_PROTOCOL_VERSIONintLDAP_OPT_ERROR_NUMBERintLDAP_OPT_REFERRALSboolLDAP_OPT_RESTARTboolLDAP_OPT_HOST_NAMEstringLDAP_OPT_ERROR_STRINGstringLDAP_OPT_DIAGNOSTIC_MESSAGEstringLDAP_OPT_MATCHED_DNstringLDAP_OPT_SERVER_CONTROLSarrayLDAP_OPT_CLIENT_CONTROLSarrayLDAP_OPT_X_KEEPALIVE_IDLEintPHP 7.1.0LDAP_OPT_X_KEEPALIVE_PROBESintPHP 7.1.0LDAP_OPT_X_KEEPALIVE_INTERVALintPHP 7.1.0LDAP_OPT_X_TLS_CACERTDIRstringPHP 7.1.0LDAP_OPT_X_TLS_CACERTFILEstringPHP 7.1.0LDAP_OPT_X_TLS_CERTFILEstringPHP 7.1.0LDAP_OPT_X_TLS_CIPHER_SUITEstringPHP 7.1.0LDAP_OPT_X_TLS_CRLCHECKintPHP 7.1.0LDAP_OPT_X_TLS_CRLFILEstringPHP 7.1.0LDAP_OPT_X_TLS_DHFILEstringPHP 7.1.0LDAP_OPT_X_TLS_KEYFILEstringPHP 7.1.0LDAP_OPT_X_TLS_PROTOCOL_MINintPHP 7.1.0LDAP_OPT_X_TLS_RANDOM_FILEstringPHP 7.1.0LDAP_OPT_X_TLS_REQUIRE_CERTintPHP 7.0.5LDAP_OPT_SERVER_CONTROLS and
LDAP_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 to &false;
if not supplied. See draft-ietf-ldapext-ldap-c-api-xx.txt
for details. See also the second example below.
value
The new value for the specified option.
&reftitle.returnvalues;
&return.success;
&reftitle.examples;
Set protocol version
]]>
Set server controls
"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";
}
?>
]]>
&reftitle.notes;
This function is only available when using OpenLDAP 2.x.x OR Netscape
Directory SDK x.x.
&reftitle.seealso;
ldap_get_option