PHP is developed and maintained by a global community of contributors.
The PHP Foundation helps fund this work. If PHP is part of your business or projects, consider sponsoring the Foundation.
(PHP 4, PHP 5, PHP 7, PHP 8)
ldap_search — Pesquisa árvore LDAP
$ldap,$base,$filter,$attributes = [],$attributes_only = 0,$sizelimit = -1,$timelimit = -1,$deref = LDAP_DEREF_NEVER,$controls = null
Realiza a pesquisa para um filtro especificado no diretório com o escopo de
of LDAP_SCOPE_SUBTREE. É equivalente a pesquisar
todo o diretório.
Também é possível realizar buscas paralelas. Neste caso, o primeiro argumento deve ser um array de
instâncias de LDAP\Connection, em vez de apenas uma instância.
Se as pesquisas não devem usar a mesma DN base e filtro, um array de DNs base e/ou um array de filtros podem ser passados como argumentos.
Esses arrays devem ter o mesmo tamanho que o array de instâncias de LDAP\Connection,
já que as primeiras entradas dos arrays são usadas para uma pesquisa, as segundas entradas são usadas para outra e assim por diante.
Ao fazer pesquisas paralelas, um array de instâncias de LDAP\Result é retornado, exceto em caso de erro, quando o valor retornado será false.
ldapUma instância de LDAP\Connection, retornada por ldap_connect().
baseO DN base para o diretório.
filterO filtro de pesquisa pode ser simples ou avançado, usando operadores booleanos no formato descrito na documentação LDAP (consulte o » Netscape Directory SDK ou a » RFC4515 para informação completa sobre filtros).
attributes
Um array dos atributos requeridos, ex.: array("mail", "sn", "cn").
Observe que "dn" é sempre retornado independente de que tipos de
atributos são requisitados.
Usar este parâmetro é muito mais eficiente que a ação padrão (que é retornar todos os atributos e seus valores associados). O uso deste parâmetro deve portanto ser considerado uma boa prática.
attributes_onlyDeve ser definido para 1 se apenas tipos de atributos são pretendidos. Se definido para 0, tanto os tipos quanto os valores dos atributos são buscados, que é o comportamento padrão.
sizelimitHabilita o limite de entradas buscadas. Definir para 0 é o mesmo que não definir limite.
Nota:
Este parâmetro NÃO consegue substituir o limite de tamanho definido no servidor. Ainda assim, ele pode ser definido para um valor menor.
Alguns servidores de diretório estarão configurados para retornar um número limitado de entradas. Se isto ocorrer, o servidor indicará que retornou um conjunto parcial de resultados. Isto também ocorre se este parâmetro for usado para limitar a contagem de entradas buscadas.
timelimitDefine o número de segundos gastos na busca. Definir para 0 é o mesmo que não definir limite.
Nota:
Este parâmetro NÃO consegue substituir o limite de tempo definido no servidor. Ainda assim, valores menores podem ser definidos.
derefEspecifica como os apelidos são gerenciados durante a busca. Pode ser uma das constantes a seguir:
LDAP_DEREF_NEVER - (padrão) apelidos nunca são
desreferenciados.
LDAP_DEREF_SEARCHING - apelidos devem ser
desreferenciados durante a busca mas não ao localizar o objeto base
da busca.
LDAP_DEREF_FINDING - apelidos devem ser
desreferenciados ao localizar o objeto base mas não durante a pesquisa.
LDAP_DEREF_ALWAYS - apelidos devem ser desreferenciados
sempre.
controlsArray de Controles LDAP que serão enviados com a requisição.
Retorna uma instância de LDAP\Result, um array de instâncias de LDAP\Result, ou false em caso de falha.
| 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.
|
| 8.1.0 | Agora retorna uma instância de LDAP\Result; anteriormente, um resource era retornado. |
| 8.0.0 |
O parâmetro controls agora pode ser nulo; anteriormente, o padrão era [].
|
| 7.3.0 |
Adicionado suporte para controls.
|
O exemplo abaixo recupera a unidade organizacional, sobrenome, nome e endereço de e-mail para todas as pessoas em "Minha Empresa" onde o sobrenome ou o nome contêm a string $person. Este exemplo usa um filtro booleano para solicitar ao sevidor que procure por informação em mais de uma atributo.
Exemplo #1 Pesquisa LDAP
<?php
// $ds é uma isntância válida de LDAP\Connection para um servidor de diretório
// $person é o nome (ou parte do nome) de uma pessoa, ex: "Jo"
$dn = "o=Minha Empresa, c=BR";
$filter="(|(sn=$person*)(givenname=$person*))";
$justthese = array("ou", "sn", "givenname", "mail");
$sr=ldap_search($ds, $dn, $filter, $justthese);
$info = ldap_get_entries($ds, $sr);
echo $info["count"]." entradas retornadas\n";
?>