<!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>Sort LDAP result entries on the client side</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ldap-set-rebind-proc.html">ldap_set_rebind_proc</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ldap-start-tls.html">ldap_start_tls</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-sort" class="refentry">
<div class="refnamediv">
<h1 class="refname">ldap_sort</h1>
<p class="verinfo">(PHP 4 >= 4.2.0, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">ldap_sort</span> — <span class="dc-title">Sort LDAP result entries on the client side</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ldap-sort-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>ldap_sort</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$link</code></span>
, <span class="methodparam"><span class="type">resource</span> <code class="parameter">$result</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$sortfilter</code></span>
)</div>
<p class="para rdfs-comment">
Sort the result of a LDAP search, returned by
<span class="function"><a href="function.ldap-search.html" class="function">ldap_search()</a></span>.
</p>
<p class="para">
As this function sorts the returned values on the client side it is possible that
you might not get the expected results in case you reach the <code class="parameter">sizelimit</code> either of the server or
defined within <span class="function"><a href="function.ldap-search.html" class="function">ldap_search()</a></span>.
</p>
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">This feature has been
<em class="emphasis">DEPRECATED</em> as of PHP 7.0.0. Relying on this feature
is highly discouraged.</p></div>
</div>
<div class="refsect1 parameters" id="refsect1-function.ldap-sort-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">link</code></dt>
<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>
<code class="parameter">result</code></dt>
<dd>
<p class="para">
An search result identifier, returned by
<span class="function"><a href="function.ldap-search.html" class="function">ldap_search()</a></span>.
</p>
</dd>
<dt>
<code class="parameter">sortfilter</code></dt>
<dd>
<p class="para">
The attribute to use as a key in the sort.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.ldap-sort-examples">
<h3 class="title">Examples</h3>
<p class="para">
Sorting the result of a search.
<div class="example" id="example-5539">
<p><strong>Example #1 LDAP sort</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 /><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: #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: #FF8000">// Sort<br /> </span><span style="color: #0000BB">ldap_sort</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">, </span><span style="color: #DD0000">'sn'</span><span style="color: #007700">);<br /><br /> </span><span style="color: #FF8000">// Retrieving the data<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">);</span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ldap-set-rebind-proc.html">ldap_set_rebind_proc</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ldap-start-tls.html">ldap_start_tls</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>
