php-doc-en/reference/ldap/functions/ldap-control-paged-result.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ --> 
<refentry xml:id='function.ldap-control-paged-result'
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>ldap_control_paged_result</refname>
  <refpurpose>Send LDAP pagination control</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
   &ldap.warn.control-paged;
 </refsynopsisdiv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>ldap_control_paged_result</methodname>
   <methodparam><type>resource</type><parameter>link</parameter></methodparam>
   <methodparam><type>int</type><parameter>pagesize</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>iscritical</parameter><initializer>&false;</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>cookie</parameter><initializer>""</initializer></methodparam>
  </methodsynopsis>
  <para>
   Enable LDAP pagination by sending the pagination control (page size, cookie...).
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>link</parameter></term>
     <listitem>
      <para>
       &ldap.parameter.ldap;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>pagesize</parameter></term>
     <listitem>
      <para>
       The number of entries by page.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>iscritical</parameter></term>
     <listitem>
      <para>
       Indicates whether the pagination is critical or not. 
       If true and if the server doesn't support pagination, the search
       will return no result.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>cookie</parameter></term>
     <listitem>
      <para>
       An opaque structure sent by the server 
       (<function>ldap_control_paged_result_response</function>).
      </para>
     </listitem>
    </varlistentry>
    </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>7.4.0</entry>
       <entry>
        This function has been deprecated.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   The example below show the retrieval of the first page of a search paginated
   with one entry by page.
   <example>
    <title>LDAP pagination</title>
    <programlisting role="php">
     <![CDATA[
     <?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;
     ]]>
    </programlisting>
   </example>
  </para>
  <para>
   The example below show the retrieval of all the result paginated with 100 
   entries by page.
   <example>
    <title>LDAP pagination</title>
    <programlisting role="php">
     <![CDATA[
     <?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 != '');
     ]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Pagination control is a LDAPv3 protocol feature.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ldap_control_paged_result_response</function></member>
    <member><link xlink:href="&url.rfc;2696">RFC2696 : LDAP Control Extension for Simple
    Paged Results Manipulation</link></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->