ldap-get-values.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: e50e79746736dbdfbabe9bd3566793b3ddf38f58 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.ldap-get-values" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ldap_get_values</refname>
  <refpurpose>Lit toutes les valeurs d'une entrée LDAP</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>ldap_get_values</methodname>
   <methodparam><type>LDAP\Connection</type><parameter>ldap</parameter></methodparam>
   <methodparam><type>LDAP\ResultEntry</type><parameter>entry</parameter></methodparam>
   <methodparam><type>string</type><parameter>attribute</parameter></methodparam>
  </methodsynopsis>
  <para>
   Lit toutes les valeurs de l'attribut d'une entrée dans un résultat.
  </para>
  <para>
   L'appel de cette fonction requiert une <parameter>entry</parameter>
   et doit donc être précédée d'une recherche LDAP,
   et de l'une des fonctions permettant d'accéder à une entrée.
  </para>
  <para>
   Votre application doit contenir des informations permettant
   de lire certains attributs (comme "nom" ou "mail"), ou bien vous
   devrez utiliser la fonction <function>ldap_get_attributes</function>
   pour savoir quels sont les attributs qui existent pour une entrée donnée.
  </para>
 </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>entry</parameter></term>
     <listitem>
      <para>
       &ldap.parameter.entry;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>attribute</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne un tableau de valeurs pour l'attribut, ou &false; en cas d'erreur.
   Le nombre de valeurs retournées est disponible à l'index 'count' du tableau
   retourné. Les valeurs sont accessibles individuellement, avec les index
   numériques du tableau. L'indexation commence à &zero;.
  </para>
  <para>
   LDAP permet plus d'une entrée par attribut, ce qui permet de stocker plusieurs
   adresses emails par personne, tout en n'utilisant qu'une étiquette "mail" :
   <informalexample>
    <literallayout>
    return_value["count"] = nombre de valeurs de l'attribut
    return_value[0] = première valeur de l'attribut
    return_value[i] = i-ième valeur de l'attribut
    </literallayout>
   </informalexample>
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &ldap.changelog.ldap-object;
     &ldap.changelog.entry-object;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Liste toutes les valeurs de l'attribut "mail" d'une entrée</title>
    <programlisting role="php">
<![CDATA[
<?php
// $ds doit être une instance de connexion LDAP\Connection valide

// $sr doit être une ressource de résultat valide, obtenue avec une des fonctions de
//     recherche LDAP.

// $entry est une entrée LDAP valide, obtenue avec une des fonctions
//        LDAP qui retourne une entrée

$values = ldap_get_values($ds, $entry,"mail");

echo $values["count"] . " adresses email pour cette entrée.<br />";

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

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