<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Send LDAP pagination control</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ldap-control-paged-result-response.html">ldap_control_paged_result_response</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ldap-count-entries.html">ldap_count_entries</a></div>
<div class="up"><a href="ref.ldap.html">LDAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.ldap-control-paged-result" class="refentry">
<div class="refnamediv">
<h1 class="refname">ldap_control_paged_result</h1>
<p class="verinfo">(PHP 5 >= 5.4.0)</p><p class="refpurpose"><span class="refname">ldap_control_paged_result</span> — <span class="dc-title">Send LDAP pagination control</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ldap-control-paged-result-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>ldap_control_paged_result</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$link</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$pagesize</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$iscritical</code><span class="initializer"> = false</span></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$cookie</code><span class="initializer"> = ""</span></span>
]] )</div>
<p class="para rdfs-comment">
Enable LDAP pagination by sending the pagination control (page size, cookie...).
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ldap-control-paged-result-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">link</code></em></span>
<dd>
<p class="para">
An LDAP link identifier, returned by <span class="function"><a href="function.ldap-connect.html" class="function">ldap_connect()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">pagesize</code></em></span>
<dd>
<p class="para">
The number of entries by page.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">iscritical</code></em></span>
<dd>
<p class="para">
Indicates whether the pagination is critical of not.
If true and if the server doesn't support pagination, the search
will return no result.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">cookie</code></em></span>
<dd>
<p class="para">
An opaque structure sent by the server
( <span class="function"><a href="function.ldap-control-paged-result-response.html" class="function">ldap_control_paged_result_response()</a></span>).
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ldap-control-paged-result-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.ldap-control-paged-result-examples">
<h3 class="title">Examples</h3>
<p class="para">
The example below show the retrieval of the first page of a search paginated
with one entry by page.
<div class="example" id="example-4393">
<p><strong>Example #1 LDAP pagination</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /> </span><span style="color: #FF8000">// $ds is a valid link identifier (see ldap_connect)<br /> </span><span style="color: #0000BB">ldap_set_option</span><span style="color: #007700">(</span><span style="color: #0000BB">$ds</span><span style="color: #007700">, </span><span style="color: #0000BB">LDAP_OPT_PROTOCOL_VERSION</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">$dn </span><span style="color: #007700">= </span><span style="color: #DD0000">'ou=example,dc=org'</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$filter </span><span style="color: #007700">= </span><span style="color: #DD0000">'(|(sn=Doe*)(givenname=John*))'</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$justthese </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'ou'</span><span style="color: #007700">, </span><span style="color: #DD0000">'sn'</span><span style="color: #007700">, </span><span style="color: #DD0000">'givenname'</span><span style="color: #007700">, </span><span style="color: #DD0000">'mail'</span><span style="color: #007700">);<br /><br /> </span><span style="color: #FF8000">// enable pagination with a page size of 1.<br /> </span><span style="color: #0000BB">ldap_control_paged_result</span><span style="color: #007700">(</span><span style="color: #0000BB">$ds</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">$sr </span><span style="color: #007700">= </span><span style="color: #0000BB">ldap_search</span><span style="color: #007700">(</span><span style="color: #0000BB">$ds</span><span style="color: #007700">, </span><span style="color: #0000BB">$dn</span><span style="color: #007700">, </span><span style="color: #0000BB">$filter</span><span style="color: #007700">, </span><span style="color: #0000BB">$justthese</span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">$info </span><span style="color: #007700">= </span><span style="color: #0000BB">ldap_get_entries</span><span style="color: #007700">(</span><span style="color: #0000BB">$ds</span><span style="color: #007700">, </span><span style="color: #0000BB">$sr</span><span style="color: #007700">);<br /><br /> echo </span><span style="color: #0000BB">$info</span><span style="color: #007700">[</span><span style="color: #DD0000">'count'</span><span style="color: #007700">] . </span><span style="color: #DD0000">' entries returned' </span><span style="color: #007700">. </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;</span>
</span>
</code></div>
</div>
</div>
</p>
<p class="para">
The example below show the retrieval of all the result paginated with 100
entries by page.
<div class="example" id="example-4394">
<p><strong>Example #2 LDAP pagination</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /> </span><span style="color: #FF8000">// $ds is a valid link identifier (see ldap_connect)<br /> </span><span style="color: #0000BB">ldap_set_option</span><span style="color: #007700">(</span><span style="color: #0000BB">$ds</span><span style="color: #007700">, </span><span style="color: #0000BB">LDAP_OPT_PROTOCOL_VERSION</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">$dn </span><span style="color: #007700">= </span><span style="color: #DD0000">'ou=example,dc=org'</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$filter </span><span style="color: #007700">= </span><span style="color: #DD0000">'(|(sn=Doe*)(givenname=John*))'</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$justthese </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'ou'</span><span style="color: #007700">, </span><span style="color: #DD0000">'sn'</span><span style="color: #007700">, </span><span style="color: #DD0000">'givenname'</span><span style="color: #007700">, </span><span style="color: #DD0000">'mail'</span><span style="color: #007700">);<br /><br /> </span><span style="color: #FF8000">// enable pagination with a page size of 100.<br /> </span><span style="color: #0000BB">$pageSize </span><span style="color: #007700">= </span><span style="color: #0000BB">100</span><span style="color: #007700">;<br /><br /> </span><span style="color: #0000BB">$cookie </span><span style="color: #007700">= </span><span style="color: #DD0000">''</span><span style="color: #007700">;<br /> do {<br /> </span><span style="color: #0000BB">ldap_control_paged_result</span><span style="color: #007700">(</span><span style="color: #0000BB">$ds</span><span style="color: #007700">, </span><span style="color: #0000BB">$pageSize</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">, </span><span style="color: #0000BB">$cookie</span><span style="color: #007700">);<br /><br /> </span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">ldap_search</span><span style="color: #007700">(</span><span style="color: #0000BB">$ds</span><span style="color: #007700">, </span><span style="color: #0000BB">$dn</span><span style="color: #007700">, </span><span style="color: #0000BB">$filter</span><span style="color: #007700">, </span><span style="color: #0000BB">$justthese</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$entries </span><span style="color: #007700">= </span><span style="color: #0000BB">ldap_get_entries</span><span style="color: #007700">(</span><span style="color: #0000BB">$ds</span><span style="color: #007700">, </span><span style="color: #0000BB">$result</span><span style="color: #007700">);<br /> <br /> foreach (</span><span style="color: #0000BB">$entries </span><span style="color: #007700">as </span><span style="color: #0000BB">$e</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$e</span><span style="color: #007700">[</span><span style="color: #DD0000">'dn'</span><span style="color: #007700">] . </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br /> }<br /><br /> </span><span style="color: #0000BB">ldap_control_paged_result_response</span><span style="color: #007700">(</span><span style="color: #0000BB">$ds</span><span style="color: #007700">, </span><span style="color: #0000BB">$result</span><span style="color: #007700">, </span><span style="color: #0000BB">$cookie</span><span style="color: #007700">);<br /> <br /> } while(</span><span style="color: #0000BB">$cookie </span><span style="color: #007700">!== </span><span style="color: #0000BB">null </span><span style="color: #007700">&& </span><span style="color: #0000BB">$cookie </span><span style="color: #007700">!= </span><span style="color: #DD0000">''</span><span style="color: #007700">);</span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.ldap-control-paged-result-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
Pagination control is a LDAPv3 protocol feature.
</p>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.ldap-control-paged-result-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.ldap-control-paged-result-response.html" class="function" rel="rdfs-seeAlso">ldap_control_paged_result_response()</a> - Retrieve the LDAP pagination cookie</span></li>
<li class="member"><a href="http://www.faqs.org/rfcs/rfc2696" class="link external">» RFC2696 : LDAP Control Extension for Simple
Paged Results Manipulation</a></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ldap-control-paged-result-response.html">ldap_control_paged_result_response</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ldap-count-entries.html">ldap_count_entries</a></div>
<div class="up"><a href="ref.ldap.html">LDAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
