ldap_control_paged_result

(PHP 5 >= 5.4.0, PHP 7)

ldap_control_paged_result — Envia controle de paginação LDAP

Aviso

Esta função foi DESCONTINUADA a partir do PHP 7.4.0 e foi REMOVIDA a partir do PHP 8.0.0. Em vez disso, o parâmetro controls da função ldap_search() deve ser usado. Veja também Controles LDAP para obter detalhes.

Descrição

ldap_control_paged_result(
    resource $link,
    int $pagesize,
    bool $iscritical = false,
    string $cookie = ""
): bool

Habilita paginação LDAP enviando o controle de paginação (tamanho da página, cookie...).

Parâmetros

link: Um recurso LDAP, retornado por ldap_connect().
pagesize: O número de entradas por página.
iscritical: Indica se a paginação é crítica ou não. Se verdadeiro e o servidor não suportar paginação, a pesquisa não retornará nenhum resultado.
cookie: Uma estrutura opaca enviada pelo servidor (ldap_control_paged_result_response()).

Valor Retornado

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

Registro de Alterações

Versão	Descrição
8.0.0	Esta função foi removida.
7.4.0	Esta função foi descontinuada.

Exemplos

Oo exemplo abaixo mostra a obtenção da primeira página de uma pesquisa paginada com apenas uma entrada por página.

Exemplo #1 Paginação LDAP

<?php
     // $ds é um identificador de conexão válido (consulte ldap_connect)
     ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3);

     $dn        = 'ou=example,dc=org';
     $filter    = '(|(sn=Doe*)(givenname=John*))';
     $justthese = array('ou', 'sn', 'givenname', 'mail');

     // habilita paginação com tamanho de página igual a 1.
     ldap_control_paged_result($ds, 1);

     $sr = ldap_search($ds, $dn, $filter, $justthese);

     $info = ldap_get_entries($ds, $sr);

     echo $info['count'] . ' entradas retornadas' . PHP_EOL;

O exemplo abaixo mostra a obtenção de todos os resultados paginados com 100 entradas por página.

Exemplo #2 Paginação LDAP

<?php
     // $ds é um identificador de conexão válido (consulte ldap_connect)
     ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3);

     $dn        = 'ou=example,dc=org';
     $filter    = '(|(sn=Doe*)(givenname=John*))';
     $justthese = array('ou', 'sn', 'givenname', 'mail');

     // habilita paginação com tamanho de página igual a 100.
     $pageSize = 100;

     $cookie = '';
     do {
         ldap_control_paged_result($ds, $pageSize, true, $cookie);

         $result  = ldap_search($ds, $dn, $filter, $justthese);
         $entries = ldap_get_entries($ds, $result);

         foreach ($entries as $e) {
             echo $e['dn'] . PHP_EOL;
         }

         ldap_control_paged_result_response($ds, $result, $cookie);

     } while($cookie !== null && $cookie != '');

Notas

Nota:
Controle de paginação é um recurso do protocolo LDAPv3.

Veja Também

ldap_control_paged_result_response() - Obtém o cookie de paginação LDAP
» RFC2696 : Extensão de Controle LDAP para Manipulação Simples de Resultados Paginados

Melhore Esta Página

Aprenda Como Melhorar Esta Página • Envie uma Solicitação de Modificação • Reporte um Problema

＋adicionar nota

Notas de Usuários 6 notes

down

James ¶

13 years ago

I was able to get these functions to work successfully with Active Directory.  When I first tried it, ldap_search kept returning a Not Supported reply from the server.  I finally figured out that I needed to include

ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3);

in my code, so that AD would let me page results.  Make sure you're using a compatible protocol.

Hope this note helps someone else.

down

Blizzz ¶

12 years ago

If you did a paged search operation and want to do any other read operation on LDAP, you need to reset it, otherwise you will experience LDAP errors (code 12, for instance).

<?php 
…
ldap_control_paged_result($link, 0);
…
?>

down

jestertrance at hotmail dot com ¶

12 years ago

You may need to do an ldap_bind before running ldap_control_paged_result to get this to work:

$conn = ldap_connect("you_ip");
ldap_set_option($conn, LDAP_OPT_PROTOCOL_VERSION, 3);
ldap_bind("your_connection_info");        
ldap_control_paged_result($conn, $pageSize, true, $cookie)

Without doing an ldap_bind, I kept getting the error "Critical extension is unavailable". I don't if this is standard knowledge, but knowing this would have saved me days of frustration.

down

steven_bauman at outlook dot com ¶

9 years ago

While another note suggests resetting the control paged result by passing in `0` (zero), it actually still prevents any further queries being ran during the same request.

You actually need to set it to a large number to run further queries it seems. For example:

<?php
ldap_control_paged_result($connection, 100, true, $cookie);

// Run the search
...

// What is supposed to work (reset)
ldap_control_paged_result($connection, 0, false, $cookie);

// What actually works
ldap_control_paged_result($connection, 1000, false, $cookie);
?>

In the above method, 1000 is just a placeholder, but this seems to actually **limit** further queries to this amount of results, so if you set it to `1`, then you'll only receive **one** result for any further queries during the same request.

down

etienne at lamaisondebarbie dot ch ¶

13 years ago

Paged results, as specified in the RFC 2696, does not allow to get over the server sizeLimit. The RFC clearly states "If the page size is greater than or equal to the sizeLimit value, the server should ignore the control as the request can be satisfied in a single page".
With OpenLDAP, you will not get more than the sizeLimit number of entries with paged results.

down

dublue at gmail dot com ¶

11 years ago

So how do you now sort the entire result? It appears you can't use ldap_sort as it uses the search resource which is within the loop.

＋adicionar nota