ldap-list.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b7cbd468cb4c46d55d43a44cade0eb4590d25dea Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.ldap-list" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ldap_list</refname>
  <refpurpose>Recherche dans un niveau</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>LDAP\Result</type><type>array</type><type>false</type></type><methodname>ldap_list</methodname>
   <methodparam><type class="union"><type>LDAP\Connection</type><type>array</type></type><parameter>ldap</parameter></methodparam>
   <methodparam><type class="union"><type>array</type><type>string</type></type><parameter>base</parameter></methodparam>
   <methodparam><type class="union"><type>array</type><type>string</type></type><parameter>filter</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>attributes</parameter><initializer>[]</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>attributes_only</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>sizelimit</parameter><initializer>-1</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>timelimit</parameter><initializer>-1</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>deref</parameter><initializer><constant>LDAP_DEREF_NEVER</constant></initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>controls</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Effectue une recherche avec le filtre <parameter>filter</parameter>
   dans le dossier <parameter>base_dn</parameter> avec l'option
   <constant>LDAP_SCOPE_ONELEVEL</constant>.
  </para>
  <para>
   <constant>LDAP_SCOPE_ONELEVEL</constant> signifie que la recherche
   ne peut retourner des entrées que dans le niveau qui est immédiatement
   sous le niveau <parameter>base</parameter> (c'est l'équivalent
   de la commande <command>ls</command>, pour obtenir la liste des fichiers et dossiers
   du dossier courant).
  </para>
  &ldap.return-result-array-info;
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>ldap</parameter></term>
     <listitem>
      <para>
       &ldap.parameter.ldap;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>base</parameter></term>
     <listitem>
      <para>
       La base DN du dossier.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>filter</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>attributes</parameter></term>
     <listitem>
      <para>
       Un tableau d'attributs requis, e.g. array("mail", "sn", "cn").
       Notez que le "dn" est toujours retourné, quelque soit le type de l'attribut
       demandé.
      </para>
      <para>
       L'utilisation de ce paramètre est plus efficace que l'action par défaut
       (qui est de retourner tous les attributs ainsi que leurs valeurs associées).
       L'utilisation de ce paramètre doit pour cette raison être considéré comme
       une bonne pratique.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>attributes_only</parameter></term>
     <listitem>
      <para>
       Doit être défini à &one; si seuls les types des attributs sont demandés.
       S'il est défini à &zero;, les types et les valeurs des attributs sont récupérés,
       ce qui correspond au comportement par défaut.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>sizelimit</parameter></term>
     <listitem>
      <para>
       Vous permet de limiter le nombre d'entrées à récupérer. Le fait
       de définir ce paramètre à &zero; signifie qu'il n'y aura aucune limite.
      </para>
      <note>
       <para>
        Ce paramètre ne peut pas écraser la configuration côté serveur. Vous
        pouvez cependant positionner une valeur inférieure.
       </para>
       <para>
        Quelques dossiers serveurs peuvent être configurés afin de ne retourner
        qu'un nombre d'entrées données. Si ce comportement survient, le serveur
        indique qu'il n'a retourné qu'un jeu de résultats partiel. Ce comportement
        intervient également si vous utilisez ce paramètre pour limiter le nombre
        d'entrées récupérées.
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>timelimit</parameter></term>
     <listitem>
      <para>
       Définit le nombre maximal de secondes permis pour la recherche.
       Le fait de définir ce paramètre à &zero; signifie qu'il n'y a pas de limite.
      </para>
      <note>
       <para>
        Ce paramètre ne peut pas écraser la configuration côté serveur mais vous
        pouvez l'utiliser pour être plus restrictif.
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>deref</parameter></term>
     <listitem>
      <para>
       Spécifie le nombre d'alias qui doivent être gérés pendant la recherche.
       Il peut être un parmi les suivants :
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>LDAP_DEREF_NEVER</constant> - (défaut) les alias ne sont jamais déréférencés.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>LDAP_DEREF_SEARCHING</constant> - les alias doivent être déréférencés
          pendant la recherche mais pas lors de la localisation de l'objet de base de la recherche.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>LDAP_DEREF_FINDING</constant> - les alias doivent être déréférencés
          lors de la localisation de l'objet de base mais pas durant la recherche.
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>LDAP_DEREF_ALWAYS</constant> - les alias doivent toujours être
          déréférencés.
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>controls</parameter></term>
     <listitem>
      <para>
       Tableau de <link linkend="ldap.controls">Contrôles LDAP</link> à envoyer avec la requête.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &ldap.return-result-array;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      &ldap.changelog.ldap-object;
      &ldap.changelog.return-result-object;
      &ldap.changelog.controls-nullable;
      <row>
       <entry>7.3.0</entry>
       <entry>
        Support pour <parameter>controls</parameter> a été ajouté.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Produit une liste de tous les services d'une société</title>
    <programlisting role="php">
<![CDATA[
<?php
// $ds doit être une instance de connexion LDAP\Connection valide

$basedn = "o=My Company, c=US";
$justthese = array("ou");

$sr = ldap_list($ds, $basedn, "ou=*", $justthese);

$info = ldap_get_entries($ds, $sr);

for ($i=0; $i < $info["count"]; $i++) {
    echo $info[$i]["ou"][0];
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ldap_search</function></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
-->