array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'pt_BR', ), 'this' => array ( 0 => 'function.ldap-get-option.php', 1 => 'ldap_get_option', 2 => 'Obtém o valor atual para a opção informada', ), 'up' => array ( 0 => 'ref.ldap.php', 1 => 'Funções do LDAP', ), 'prev' => array ( 0 => 'function.ldap-get-entries.php', 1 => 'ldap_get_entries', ), 'next' => array ( 0 => 'function.ldap-get-values.php', 1 => 'ldap_get_values', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'pt_BR', 'path' => 'reference/ldap/functions/ldap-get-option.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

ldap_get_option

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

ldap_get_option — Obtém o valor atual para a opção informada

Descrição

ldap_get_option(?LDAP\Connection $ldap, int $option, array|string|int &$value = null): bool

Obtém o valor da opção especificada e armazena em value.

Parâmetros

ldap

Uma instância de LDAP\Connection retornada por ldap_connect(), para obter a opção para essa conexão, ou null para obter a opção global.

option

O parâmetro option pode ser um destes valores:
Opção Tipo 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_DIAGNOSTIC_MESSAGE string  
LDAP_OPT_REFERRALS int  
LDAP_OPT_RESTART int  
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_X_KEEPALIVE_IDLE int 7.1
LDAP_OPT_X_KEEPALIVE_PROBES int 7.1
LDAP_OPT_X_KEEPALIVE_INTERVAL int 7.1
LDAP_OPT_X_TLS_CACERTDIR string 7.1
LDAP_OPT_X_TLS_CACERTFILE string 7.1
LDAP_OPT_X_TLS_CERTFILE string 7.1
LDAP_OPT_X_TLS_CIPHER_SUITE string 7.1
LDAP_OPT_X_TLS_CRLCHECK int 7.1
LDAP_OPT_X_TLS_CRL_NONE int 7.1
LDAP_OPT_X_TLS_CRL_PEER int 7.1
LDAP_OPT_X_TLS_CRL_ALL int 7.1
LDAP_OPT_X_TLS_CRLFILE string 7.1
LDAP_OPT_X_TLS_DHFILE string 7.1
LDAP_OPT_X_TLS_KEYFILE string 7.1
LDAP_OPT_X_TLS_PACKAGE string 7.1
LDAP_OPT_X_TLS_PROTOCOL_MIN int 7.1
LDAP_OPT_X_TLS_RANDOM_FILE string 7.1
LDAP_OPT_X_TLS_REQUIRE_CERT int  

value

Esta variável po referência irá armazenar o valor da opção informada.

Valor Retornado

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

Registro de Alterações

Versão Descrição
8.5.0 ldap agora pode ser nulo.
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

Exemplo #1 Verifica a versão do protocolo

<?php
// $ds é uma instância válida de LDAP\Connection para um servidor de diretório
if (ldap_get_option($ds, LDAP_OPT_PROTOCOL_VERSION, $version)) {
echo "Usando protocolo versão $version\n";
} else {
echo "Não foi possível determinar a versão do protocolo\n";
}
?>

Notas

Nota:

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

Veja Também