ldap-get-values.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ldap-get-values" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ldap_get_values</refname>
  <refpurpose>Get all values from a result entry</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>
   Reads all the values of the attribute in the entry in the result.
  </para>
  <para>
   This call needs a <parameter>entry</parameter>,
   so needs to be preceded by one of the ldap search calls and one
   of the calls to get an individual entry.
  </para>
  <para>
   You application will either be hard coded to look for certain
   attributes (such as "surname" or "mail") or you will have to use
   the <function>ldap_get_attributes</function> call to work out
   what attributes exist for a given entry.
  </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>
   Returns an array of values for the attribute on success and &false; on
   error. The number of values can be found by indexing "count" in the
   resultant array. Individual values are accessed by integer index in the
   array.  The first index is 0.
  </para>
  <para>
   LDAP allows more than one entry for an attribute, so it can, for example,
   store a number of email addresses for one person's directory entry all
   labeled with the attribute "mail"
   <informalexample>
    <literallayout>
    return_value["count"] = number of values for attribute
    return_value[0] = first value of attribute
    return_value[i] = ith value of attribute
    </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>List all values of the "mail" attribute for a directory entry</title>
    <programlisting role="php">
<![CDATA[
<?php
// $ds is a valid LDAP\Connection instance for a directory server

// $sr is a valid search result from a prior call to
//     one of the ldap directory search calls

// $entry is a valid entry identifier from a prior call to
//        one of the calls that returns a directory entry

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

echo $values["count"] . " email addresses for this entry.<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
-->