ldap_set_option

(PHP 4 >= 4.0.4, PHP 5)

ldap_set_option — Establecer el valor de la opción proporcionada

Descripción

bool ldap_set_option ( resource $link_identifier , int $option , mixed $newval )

Establece el valor de la opción especificada a newval.

Parámetros

link_identifier

Un identificador de enlace de LDAP, devuelto por ldap_connect().

option

El parámetro option puede ser uno de estos:
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_MATCHED_DN string  
LDAP_OPT_SERVER_CONTROLS array  
LDAP_OPT_CLIENT_CONTROLS array  

LDAP_OPT_SERVER_CONTROLS y LDAP_OPT_CLIENT_CONTROLS requieren una lista de controles, lo que significa que el valor debe ser un array de controles. Un control consiste en un oid identificando el control, un value opcional, y un indicador opcional representado por criticality. En PHP un control es proporcionado por un array que contiene un elemento con la clave oid, una cadena de valor, y dos elementos opcionales. Los elementos opcionales son la clave value con un valor de tipo cadena, y la clave iscritical con un valor de tipo booleano. El valor de la clave iscritical de forma predeterminada es FALSE si no es provisto. Vea » draft-ietf-ldapext-ldap-c-api-xx.txt para más detalles. Vea también el segundo ejemplo a continuación.

newval

El nuevo valor para el option especificado.

Valores devueltos

Devuelve TRUE en caso de éxito o FALSE en caso de error.

Ejemplos

Ejemplo #1 Establecer la versión del protocolo

<?php
// $ds es un identificador de enlace válido para un servidor de directorio
if (ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3)) {
    echo "Utilizando LDAPv3";
} else {
    echo "Falló al establcer la versión 3 del protocolo";
}
?>

Ejemplo #2 Establecer controles del servidor

<?php
// $ds es un identificador de enlace válido para un servidor de directorio
// control sin valor
$ctrl1 = array("oid" => "1.2.752.58.10.1", "iscritical" => true);
// iscritical de forma predeterminada está en FALSE
$ctrl2 = array("oid" => "1.2.752.58.1.10", "value" => "magic");
// intentar establecer ambos controles
if (!ldap_set_option($ds, LDAP_OPT_SERVER_CONTROLS, array($ctrl1, $ctrl2))) {
    echo "Falló al establecer los controles del servidor";
}
?>

Notas

Nota:

Esta función está disponible solamente cuando se utiliza OpenLDAP 2.x.x ó Netscape Directory SDK x.x.

Ver también