<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="function.ldap-list" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>ldap_list</refname>

<refpurpose>Выполняет одноуровневый поиск</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type class="union"><type>LDAP\Result</type><type>array</type><type>false</type></type><methodname>ldap_list</methodname>

<methodparam><type class="union"><type>LDAP\Connection</type><type>array</type></type><parameter>ldap</parameter></methodparam>

<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>base</parameter></methodparam>

<methodparam><type class="union"><type>array</type><type>string</type></type><parameter>filter</parameter></methodparam>

<methodparam choice="opt"><type>array</type><parameter>attributes</parameter><initializer>[]</initializer></methodparam>

<methodparam choice="opt"><type>int</type><parameter>attributes_only</parameter><initializer>0</initializer></methodparam>

<methodparam choice="opt"><type>int</type><parameter>sizelimit</parameter><initializer>-1</initializer></methodparam>

<methodparam choice="opt"><type>int</type><parameter>timelimit</parameter><initializer>-1</initializer></methodparam>

<methodparam choice="opt"><type>int</type><parameter>deref</parameter><initializer><constant>LDAP_DEREF_NEVER</constant></initializer></methodparam>

<methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>controls</parameter><initializer>&null;</initializer></methodparam>

</methodsynopsis>

<para>

Функция выполняет поиск по заданному фильтру <parameter>filter</parameter>

в каталоге с областью действия <constant>LDAP_SCOPE_ONELEVEL</constant>.

</para>

<para>

Константа <constant>LDAP_SCOPE_ONELEVEL</constant> означает, что поиск

вернёт только информацию с уровня непосредственно ниже

уровня <parameter>base</parameter>, который задали при вызове.

(Эквиваленто вводу команды <command>ls</command> и получению списка файлов и папок

в текущем рабочем каталоге.)

</para>

&ldap.return-result-array-info;

</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>base</parameter></term>

<listitem>

<para>

Базовое DN для каталога.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>filter</parameter></term>

<listitem>

<para>

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>attributes</parameter></term>

<listitem>

<para>

Массив необходимых атрибутов, например, <literal>array("mail", "sn", "cn")</literal>.

Обратите внимание, что dn возвращается всегда, независимо от того, какие

типы атрибутов требуются.

</para>

<para>

Этот параметр работает эффективнее, чем действие по умолчанию,

которое возвращает все атрибуты и связанные с ними значения.

Вызов функции с этим параметром считают хорошей практикой.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>attributes_only</parameter></term>

<listitem>

<para>

Должен быть равен 1, только если требуются типы атрибута. Если установлено

0, то, по умолчанию, выбираются и типы атрибутов и значения атрибута.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>sizelimit</parameter></term>

<listitem>

<para>

Позволяет ограничить количество выбранных записей. Установка этого параметра

как 0 означает, что ограничение отсутствует.

</para>

<note>

<para>

Этот параметр НЕ может переопределять предустановку sizelimit на стороне сервера.

Хотя его можно установить ниже.

</para>

<para>

Некоторые хосты серверов каталогов будут сконфигурированы так, чтобы

возвратить не больше, чем предварительно установленное число записей. Если

это произойдёт, то сервер укажет, что возвратил только частичный набор

результатов. Это также происходит, если Вы используете этот параметр, чтобы

ограничить количество выбранных записей.

</para>

</note>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>timelimit</parameter></term>

<listitem>

<para>

Устанавливает число секунд, ограничивающее процесс поиска.

Установка этого параметра как 0 означает, что ограничение отсутствует.

</para>

<note>

<para>

Этот параметр НЕ может переопределять предустановку timelimit на стороне сервера.

Хотя его можно установить ниже.

</para>

</note>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>deref</parameter></term>

<listitem>

<para>

Определяет, как псевдонимы должны быть обработаны во время поиска. Может

быть одним из следующих:

<itemizedlist>

<listitem>

<simpara>

<constant>LDAP_DEREF_NEVER</constant> — (по умолчанию) псевдонимы никогда не разыменовываться.

</simpara>

</listitem>

<listitem>

<simpara>

<constant>LDAP_DEREF_SEARCHING</constant> — псевдонимы должны быть разыменованы во время поиска,

но не при определении местоположения базового объекта поиска.

</simpara>

</listitem>

<listitem>

<simpara>

<constant>LDAP_DEREF_FINDING</constant> — псевдонимы должны быть разыменованы при определении

местоположения базового объекта, но не во время поиска.

</simpara>

</listitem>

<listitem>

<simpara>

<constant>LDAP_DEREF_ALWAYS</constant> — псевдонимы должны всегда разыменовываться всегда.

</simpara>

</listitem>

</itemizedlist>

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>controls</parameter></term>

<listitem>

<para>

Массив <link linkend="ldap.controls">управляющих объектов протокола LDAP</link> для отправки в запросе.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

&ldap.return-result-array;

</para>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<para>

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

&ldap.changelog.ldap-object;

&ldap.changelog.return-result-object;

&ldap.changelog.controls-nullable;

<row>

<entry>7.3.0</entry>

<entry>

Добавлена поддержка параметра <parameter>controls</parameter>

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Выводит список всех организационных единиц организации</title>

<programlisting role="php">

</programlisting>

</example>

</para>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<para>

<simplelist>

<member><function>ldap_search</function></member>

</simplelist>

</para>

</refsect1>

</refentry>