PHP.nl

ldap_control_paged_result

ldap_control_paged_result

Send LDAP pagination control

bool **ldap_control_paged_result** resource $link int $pagesize bool $iscritical string $cookie

Enable LDAP pagination by sending the pagination control (page size, cookie...).

link An LDAP resource, returned by . ldap_connect

pagesizeThe number of entries by page.

iscriticalIndicates whether the pagination is critical or not. If true and if the server doesn't support pagination, the search will return no result.

cookie An opaque structure sent by the server (). ldap_control_paged_result_response

return.success

The example below show the retrieval of the first page of a search paginated with one entry by page.

Voorbeeld: LDAP pagination

<?php
     // $ds is a valid link identifier (see 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');

     // enable pagination with a page size of 1.
     ldap_control_paged_result($ds, 1);

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

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

     echo $info['count'] . ' entries returned' . PHP_EOL;

The example below show the retrieval of all the result paginated with 100 entries by page.

Voorbeeld: LDAP pagination

<?php
     // $ds is a valid link identifier (see 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');

     // enable pagination with a page size of 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 != '');

Opmerking: > Pagination control is a LDAPv3 protocol feature.

ldap_control_paged_result_responseRFC2696 : LDAP Control Extension for Simple Paged Results Manipulation

Vorige ← ldap_control_paged_result_response Volgende ldap_count_entries →

Documentatie