ldap_set_option

(PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8)

ldap_set_option — Define o valor para a opção informada

Descrição

ldap_set_option(?LDAP\Connection $ldap, int $option, array|string|int|bool $value): bool

Define, para a opção especificada, o valor informado em value.

Parâmetros

ldap

Pode ser uma instância de LDAP\Connection, retornada por ldap_connect(), para definir a opção para essa conexão, ou null para definir a opção de forma global.

option

O parâmetro option pode ser uma das constantes:

Opção Tipo Disponível desde
LDAP_OPT_DEREF int  
LDAP_OPT_SIZELIMIT int  
LDAP_OPT_TIMELIMIT int  
LDAP_OPT_NETWORK_TIMEOUT int  
LDAP_OPT_PROTOCOL_VERSION int  
LDAP_OPT_ERROR_NUMBER int  
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 PHP 7.1.0
LDAP_OPT_X_KEEPALIVE_PROBES int PHP 7.1.0
LDAP_OPT_X_KEEPALIVE_INTERVAL int PHP 7.1.0
LDAP_OPT_X_TLS_CACERTDIR string PHP 7.1.0
LDAP_OPT_X_TLS_CACERTFILE string PHP 7.1.0
LDAP_OPT_X_TLS_CERTFILE string PHP 7.1.0
LDAP_OPT_X_TLS_CIPHER_SUITE string PHP 7.1.0
LDAP_OPT_X_TLS_CRLCHECK int PHP 7.1.0
LDAP_OPT_X_TLS_CRLFILE string PHP 7.1.0
LDAP_OPT_X_TLS_DHFILE string PHP 7.1.0
LDAP_OPT_X_TLS_KEYFILE string PHP 7.1.0
LDAP_OPT_X_TLS_PROTOCOL_MIN int PHP 7.1.0
LDAP_OPT_X_TLS_RANDOM_FILE string PHP 7.1.0
LDAP_OPT_X_TLS_REQUIRE_CERT int PHP 7.0.5

LDAP_OPT_SERVER_CONTROLS e LDAP_OPT_CLIENT_CONTROLS requerem uma lista de controles, que significa que o valor precisa ser um array de controles. Um controle consiste de um oid identificando o controle, um valor opcional, e um sinalizador opcional para criticalidade. No PHP, um controle é dado por um array contendo um elemento com a chave oid e um valor string, e dois elementos opcionais. Os elementos opcionais são a chave value com um valor string e a chave iscritical com valor booleano. O padrão de iscritical é false se não fornecido. Consulte » draft-ietf-ldapext-ldap-c-api-xx.txt para detalhes. Consulte também o segundo exemplo abaixo.

value

O novo valor para a opção especificada em option.

Valor Retornado

Retorna true em caso de sucesso ou false em caso de falha.

Registro de Alterações

Versão Descrição
8.1.0 O parâmetro ldap agora espera uma instância de LDAP\Connection; anteriormente, um resource ldap link válido era esperado.

Exemplos

Example #1 Define a versão de protocolo

<?php
// $ds é uma instância válida de LDAP\Connection para um servidor de diretório
if (ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3)) {
    echo "Usando LDAPv3";
} else {
    echo "Falha ao definir protocolo para versão 3";
}
?>

Example #2 Set server controls

<?php
// $ds é uma instância válida de LDAP\Connection para um servidor de diretório
// controle sem valor
$ctrl1 = array("oid" => "1.2.752.58.10.1", "iscritical" => true);
// o padrão de "iscritical" é FALSE
$ctrl2 = array("oid" => "1.2.752.58.1.10", "value" => "magic");
// tente definir os dois controles
if (!ldap_set_option($ds, LDAP_OPT_SERVER_CONTROLS, array($ctrl1, $ctrl2))) {
    echo "Falha ao definir controles do servidor";
}
?>

Notas

Note:

Esta função está disponível somente ao usar OpenLDAP 2.x.x OU Netscape Directory SDK x.x.

Veja Também