ldap_set_option

Descripción

bool ldap_set_option ( resource identificador_de_conexion, int opcion, mixed nuevo_valor )

Establece el valor de la opción especificada al valor del parámetro nuevo_valor. Devuelve TRUE si todo se llevó a cabo correctamente, FALSE en caso de fallo. en caso de error.

El parámetro opcion puede contener uno de los siguientes valores: LDAP_OPT_DEREF, LDAP_OPT_SIZELIMIT, LDAP_OPT_TIMELIMIT, LDAP_OPT_PROTOCOL_VERSION, LDAP_OPT_ERROR_NUMBER, LDAP_OPT_REFERRALS, LDAP_OPT_RESTART, LDAP_OPT_HOST_NAME, LDAP_OPT_ERROR_STRING, LDAP_OPT_MATCHED_DN, LDAP_OPT_SERVER_CONTROLS, LDAP_OPT_CLIENT_CONTROLS. Para obtener una descripción de cada uno de ellos consulte la siguiente dirección draft-ietf-ldapext-ldap-c-api-xx.txt.

Las opciones LDAP_OPT_DEREF, LDAP_OPT_SIZELIMIT, LDAP_OPT_TIMELIMIT, LDAP_OPT_PROTOCOL_VERSION y LDAP_OPT_ERROR_NUMBER tienen valores numericos enteros, LDAP_OPT_REFERRALS y LDAP_OPT_RESTART deben contener valores booleanos, y las opciones LDAP_OPT_HOST_NAME, LDAP_OPT_ERROR_STRING y LDAP_OPT_MATCHED_DN deben ser cadenas de texto. El primer ejemplo muestra la forma de emplearlos. Las opciones LDAP_OPT_SERVER_CONTROLS y LDAP_OPT_CLIENT_CONTROLS requieren una lista de controles, por lo que su valor debe ser un array de controles. Los controles están formados por un oid que identifica el control, un parámetro valor opcional, y un último parámetro que indica si el cotrol es crítico. En PHP, los controles se construyen mediante un array asociativo que contenga un elemento con la clave oid y su valor como cadena de texto, y otros 2 parámetros opcionales. Estos 2 parámetros se indican como un elemento de clave value y valor una cadena de texto y un elemento con clave iscritical y un valor booleano. El valor por defecto de iscritical es FALSE. Vea también el segundo ejemplo que se muestra a continuación.

Ejemplo 1. Establecer la versión del protocolo <?php // $ds es un identificador de conexion valido if (ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3)) {     echo "Se esta empleando LDAPv3"; } else {     echo "No se ha podido establecer el protocolo a LDAP version 3"; } ?>

Ejemplo 2. Establecer controles de servidor <?php // $ds es un identificador de conexion valido // control sin valor $ctrl1 = array("oid" => "1.2.752.58.10.1", "iscritical" => true); // iscritical tiene un valor FALSE por defecto $ctrl2 = array("oid" => "1.2.752.58.1.10", "value" => "magic"); // establecer los 2 controles a la vez if (!ldap_set_option($ds, LDAP_OPT_SERVER_CONTROLS, array($ctrl1, $ctrl2)))     echo "No se han podido establecer los controles de servidor"; ?>

Vea también ldap_get_option().