mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 18:38:55 +00:00
5b9fc29465
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@78496 c90b9560-bf6c-de11-be94-00142212c4b1
91 lines
3 KiB
XML
91 lines
3 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.2 $ -->
|
|
<!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 -->
|
|
<refentry id="function.ldap-get-attributes">
|
|
<refnamediv>
|
|
<refname>ldap_get_attributes</refname>
|
|
<refpurpose>Get attributes from a search result entry</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>ldap_get_attributes</methodname>
|
|
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
|
|
<methodparam><type>resource</type><parameter>result_entry_identifier</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns a complete entry information in a multi-dimensional array
|
|
on success and &false; on error.</para>
|
|
<para>
|
|
<function>ldap_get_attributes</function> function is used to
|
|
simplify reading the attributes and values from an entry in the
|
|
search result. The return value is a multi-dimensional array of
|
|
attributes and values.</para>
|
|
<para>
|
|
Having located a specific entry in the directory, you can find
|
|
out what information is held for that entry by using this
|
|
call. You would use this call for an application which "browses"
|
|
directory entries and/or where you do not know the structure of
|
|
the directory entries. In many applications you will be searching
|
|
for a specific attribute such as an email address or a surname,
|
|
and won't care what other data is held.</para>
|
|
<para>
|
|
<informalexample><literallayout>
|
|
return_value["count"] = number of attributes in the entry
|
|
return_value[0] = first attribute
|
|
return_value[n] = nth attribute
|
|
|
|
return_value["attribute"]["count"] = number of values for attribute
|
|
return_value["attribute"][0] = first value of the attribute
|
|
return_value["attribute"][i] = (i+1)th value of the attribute
|
|
</literallayout></informalexample>
|
|
|
|
<example>
|
|
<title>Show the list of attributes held for a particular directory
|
|
entry </title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
// $ds is the link identifier for the directory
|
|
|
|
// $sr is a valid search result from a prior call to
|
|
// one of the ldap directory search calls
|
|
|
|
$entry = ldap_first_entry($ds, $sr);
|
|
|
|
$attrs = ldap_get_attributes($ds, $entry);
|
|
|
|
echo $attrs["count"]." attributes held for this entry:<p>";
|
|
|
|
for ($i=0; $i<$attrs["count"]; $i++)
|
|
echo $attrs[$i]."<br>";
|
|
]]>
|
|
</programlisting>
|
|
</example></para>
|
|
|
|
<para>
|
|
See also <function>ldap_first_attribute</function> and
|
|
<function>ldap_next_attribute</function></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:"../../../../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
|
|
-->
|