mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-23 04:18:56 +00:00
c030e2adf7
- All id attributes are now xml:id - Add docbook namespace to all root elements - Replace <ulink /> with <link xlink:href /> - Minor markup fixes here and there git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238160 c90b9560-bf6c-de11-be94-00142212c4b1
260 lines
7.4 KiB
XML
260 lines
7.4 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.7 $ -->
|
|
<refentry xml:id="function.ldap-list" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>ldap_list</refname>
|
|
<refpurpose>Single-level search</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<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>
|
|
Performs the search for a specified <parameter>filter</parameter> on the
|
|
directory with the scope <constant>LDAP_SCOPE_ONELEVEL</constant>.
|
|
</para>
|
|
<para>
|
|
<constant>LDAP_SCOPE_ONELEVEL</constant> 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>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>link_identifier</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
An LDAP link identifier, returned by <function>ldap_connect</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>base_dn</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The base DN for the directory.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>filter</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>attributes</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
An array of the required attributes, e.g. array("mail", "sn", "cn").
|
|
Note that the "dn" is always returned irrespective of which attributes
|
|
types are requested.
|
|
</para>
|
|
<para>
|
|
Using this parameter is much more efficient than the default action
|
|
(which is to return all attributes and their associated values).
|
|
The use of this parameter should therefore be considered good
|
|
practice.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>attrsonly</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Should be set to 1 if only attribute types are wanted. If set to 0
|
|
both attributes types and attribute values are fetched which is the
|
|
default behaviour.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>sizelimit</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Enables you to limit the count of entries fetched. Setting this to 0
|
|
means no limit.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
This parameter can NOT override server-side preset sizelimit. You can
|
|
set it lower though.
|
|
</para>
|
|
<para>
|
|
Some directory server hosts will be configured to return no more than
|
|
a preset number of entries. If this occurs, the server will indicate
|
|
that it has only returned a partial results set. This also occurs if
|
|
you use this parameter to limit the count of fetched entries.
|
|
</para>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>timelimit</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Sets the number of seconds how long is spend on the search. Setting
|
|
this to 0 means no limit.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
This parameter can NOT override server-side preset timelimit. You can
|
|
set it lower though.
|
|
</para>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>deref</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies how aliases should be handled during the search. It can be
|
|
one of the following:
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>LDAP_DEREF_NEVER</constant> - (default) aliases are never
|
|
dereferenced.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>LDAP_DEREF_SEARCHING</constant> - aliases should be
|
|
dereferenced during the search but not when locating the base object
|
|
of the search.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>LDAP_DEREF_FINDING</constant> - aliases should be
|
|
dereferenced when locating the base object but not during the search.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>LDAP_DEREF_ALWAYS</constant> - aliases should be dereferenced
|
|
always.
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns a search result identifier or &false; on error.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>4.0.5</entry>
|
|
<entry>
|
|
Parallel searches support was added. See
|
|
<function>ldap_search</function> for details.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>4.0.2</entry>
|
|
<entry>
|
|
The <parameter>attrsonly</parameter>, <parameter>sizelimit</parameter>,
|
|
<parameter>timelimit</parameter> and <parameter>deref</parameter> were
|
|
added.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<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>
|
|
</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:"../../../../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
|
|
-->
|