ldap_control_paged_result

(PHP 5 >= 5.4.0, PHP 7)

ldap_control_paged_result — Send LDAP pagination control

说明

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

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

参数

link

An LDAP link identifier, returned by ldap_connect().

pagesize

The number of entries by page.

iscritical

Indicates 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()).

返回值

成功时返回 TRUE， 或者在失败时返回 FALSE。

范例

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

Example #1 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.

Example #2 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 != '');

注释

Note:

Pagination control is a LDAPv3 protocol feature.

相关文章
php gupnp 函数 set control point callbackphp ldap 函数 retrieve the ldap pagination cookiephp ldap 函数 send ldap pagination controlphp ldap 函数 count the number of entries in a searchphp ldap 函数 return first referencephp ldap 函数 free result memoryphp ldap 函数 replace attribute values with new onesphp ldap 函数 get the next attribute in resultphp ldap 函数 translate t61 characters to 8859 charactersphp ldap 函数 unbind from ldap directoryphp mcve 函数 finalize and send the transactionphp output control 函数 得到所有输出缓冲区的状态php output control 函数 在ob start中使用的用来压缩输出缓冲区中内容的回调函数。ob start callback function to gzip output bufferphp output control 函数 添加url重写器的值（add url rewriter values）php posix 函数 get process group id for job controlphp posix 函数 set process group id for job controlphp ssh2 函数 send a file via scpphp uopz 函数 allows control over disabled exit opcodephp win32service 函数 returns the last control message that was sent to this servicephp win32service 函数 send a custom control to the service
关注编程学问公众号