ldap-sort.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: e706a6b5578e9d0a9d1a101eeb654124db97e0ed Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id='function.ldap-sort' xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ldap_sort</refname>
  <refpurpose>Trie les entrées d'un résultat LDAP côté client</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  &warn.deprecated.function-7-0-0.removed-8-0-0;
 </refsynopsisdiv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>ldap_sort</methodname>
   <methodparam><type>resource</type><parameter>link</parameter></methodparam>
   <methodparam><type>resource</type><parameter>result</parameter></methodparam>
   <methodparam><type>string</type><parameter>sortfilter</parameter></methodparam>
  </methodsynopsis>
  <para>
   Trie le résultat d'une recherche LDAP, retournée par la fonction
   <function>ldap_search</function>.
  </para>
  <para>
   Comme cette fonction trie les valeurs retournées du côté client, il est 
   possible que vous n'obteniez pas les résultats escomptés si vous atteignez 
   <parameter>sizelimit</parameter> soit du serveur, soit défini dans
   <function>ldap_search</function>.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>link</parameter></term>
     <listitem>
      <para>
       Une &resource; LDAP, retourné par <function>ldap_connect</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>result</parameter></term>
     <listitem>
      <para>
       Un identifiant de recherche LDAP, retourné par la fonction
       <function>ldap_search</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>sortfilter</parameter></term>
     <listitem>
      <para>
       L'attribut à utiliser comme clé lors du tri.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </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>8.0.0</entry>
       <entry>
        Cette fonction a été supprimée.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   Trie le résultat d'une recherche.
   <example>
    <title>Tri LDAP</title>
    <programlisting role="php">
<![CDATA[
<?php
// $ds est un identifiant de lien valide (voir ldap_connect)

$dn        = 'ou=example,dc=org';
$filter    = '(|(sn=Doe*)(givenname=John*))';
$justthese = array('ou', 'sn', 'givenname', 'mail');

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

// Trie
ldap_sort($ds, $sr, 'sn');

// Récupération des données
$info = ldap_get_entries($ds, $sr);
]]>
    </programlisting>
   </example>
  </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
-->