2002-04-15 00:12:54 +00:00
|
|
|
<?xml version="1.0" encoding="iso-8859-1"?>
|
2002-04-17 06:45:35 +00:00
|
|
|
<!-- $Revision: 1.2 $ -->
|
2002-04-15 00:12:54 +00:00
|
|
|
<!-- splitted from ./en/functions/ldap.xml, last change in rev 1.2 -->
|
|
|
|
|
<refentry id="function.ldap-list">
|
|
|
|
|
<refnamediv>
|
|
|
|
|
<refname>ldap_list</refname>
|
|
|
|
|
<refpurpose>Single-level search</refpurpose>
|
|
|
|
|
</refnamediv>
|
|
|
|
|
<refsect1>
|
|
|
|
|
<title>Description</title>
|
|
|
|
|
<methodsynopsis>
|
|
|
|
|
<type>resource</type><methodname>ldap_list</methodname>
|
|
|
|
|
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
|
|
|
|
|
<methodparam><type>string</type><parameter>base_dn</parameter></methodparam>
|
|
|
|
|
<methodparam><type>string</type><parameter>filter</parameter></methodparam>
|
|
|
|
|
<methodparam choice="opt"><type>array</type><parameter>attributes</parameter></methodparam>
|
|
|
|
|
<methodparam choice="opt"><type>int</type><parameter>attrsonly</parameter></methodparam>
|
|
|
|
|
<methodparam choice="opt"><type>int</type><parameter>sizelimit</parameter></methodparam>
|
|
|
|
|
<methodparam choice="opt"><type>int</type><parameter>timelimit</parameter></methodparam>
|
|
|
|
|
<methodparam choice="opt"><type>int</type><parameter>deref</parameter></methodparam>
|
|
|
|
|
</methodsynopsis>
|
|
|
|
|
<para>
|
|
|
|
|
Returns a search result identifier or &false; on error.</para>
|
|
|
|
|
<para>
|
|
|
|
|
<function>ldap_list</function> performs the search for a specified
|
|
|
|
|
<parameter>filter</parameter> on the directory with the scope
|
|
|
|
|
LDAP_SCOPE_ONELEVEL.</para>
|
|
|
|
|
<para>
|
|
|
|
|
LDAP_SCOPE_ONELEVEL means that the search should only return
|
|
|
|
|
information that is at the level immediately below the
|
|
|
|
|
<parameter>base_dn</parameter> given in the call.
|
|
|
|
|
(Equivalent to typing "ls" and getting a list
|
|
|
|
|
of files and folders in the current working directory.)</para>
|
|
|
|
|
<para>
|
|
|
|
|
This call takes 5 optional parameters. See <function>ldap_search</function>
|
|
|
|
|
notes.
|
|
|
|
|
<note>
|
|
|
|
|
<para>
|
|
|
|
|
These optional parameters were added in 4.0.2:
|
|
|
|
|
<parameter>attrsonly</parameter>,
|
|
|
|
|
<parameter>sizelimit</parameter>,
|
|
|
|
|
<parameter>timelimit</parameter>,
|
|
|
|
|
<parameter>deref</parameter>.
|
|
|
|
|
</para>
|
|
|
|
|
</note>
|
|
|
|
|
|
|
|
|
|
<example>
|
|
|
|
|
<title>Produce a list of all organizational units of an organization
|
|
|
|
|
</title>
|
|
|
|
|
<programlisting role="php3">
|
|
|
|
|
<![CDATA[
|
|
|
|
|
// $ds is a valid link identifier for a directory server
|
|
|
|
|
|
|
|
|
|
$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>
|
|
|
|
|
<note>
|
|
|
|
|
<para>
|
|
|
|
|
From 4.0.5 on it's also possible to do parallel searches. See
|
|
|
|
|
<function>ldap_search</function> for details.
|
|
|
|
|
</para>
|
|
|
|
|
</note>
|
|
|
|
|
</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
|
|
|
|
|
-->
|
