array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'pt_BR', ), 'this' => array ( 0 => 'function.ldap-read.php', 1 => 'ldap_read', 2 => 'Lê uma entrada', ), 'up' => array ( 0 => 'ref.ldap.php', 1 => 'Funções do LDAP', ), 'prev' => array ( 0 => 'function.ldap-parse-result.php', 1 => 'ldap_parse_result', ), 'next' => array ( 0 => 'function.ldap-rename.php', 1 => 'ldap_rename', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'pt_BR', 'path' => 'reference/ldap/functions/ldap-read.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

ldap_read

(PHP 4, PHP 5, PHP 7, PHP 8)

ldap_read — Lê uma entrada

Descrição

ldap_read(
    LDAP\Connection|array $ldap,
    array|string $base,
    array|string $filter,
    array $attributes = [],
    int $attributes_only = 0,
    int $sizelimit = -1,
    int $timelimit = -1,
    int $deref = LDAP_DEREF_NEVER,
    ?array $controls = null
): LDAP\Result|array|false

Realiza a pesquisa para um filtro especificado em filter no diretório com o escopo LDAP_SCOPE_BASE. É equivalente a ler uma entrada do 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.

Parâmetros

ldap

Uma instância de LDAP\Connection, retornada por ldap_connect().

base

O DN base para o diretório.

filter

Um filtro vazio não é permitido. Se for desejado recuperar absolutamente todas as informações para esta entrada, deve ser usado um filtro de objectClass=*. Se são conhecidos os tipos de entrada usados no servidor de diretório, pode-se usar um filtro apropriado tal como objectClass=inetOrgPerson.

attributes

Um array dos atributos requeridos, ex.: array("mail", "sn", "cn"). Observe que o "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_only

Deve ser definido apra 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.

sizelimit

Habilita 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 limutado 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.

timelimit

Define 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.

deref

Especifica 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.

controls

Array de Controles LDAP que serão enviados com a requisição.

Valor Retornado

Retorna uma instância de LDAP\Result, um array de instâncias de LDAP\Result, 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.
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.