ldap_read

(PHP 4, PHP 5, PHP 7, PHP 8)

ldap_read — Читает запись

Описание

ldap_read(
    LDAP\Connection|array $ldap,
    array|string $base,
    array|string $filter,
    array $attributes = [],
    int $attributes_only = 0,
    int $sizelimit = -1,
    int $timelimit = -1,
    int $deref = LDAP_DEREF_NEVER,
    ?array $controls = null
): LDAP\Result|array|false

Функция выполняет поиск для заданного фильтра filter в каталоге в каталоге с областью действия LDAP_SCOPE_BASE. Эквивалентно чтению записи из директории.

Можно также выполнять параллельный поиск. В этом случае первым аргументом должен быть массив экземпляров LDAP\Connection, а не один экземпляр. Если поиск не должен использовать один и тот же базовый DN и фильтр, в качестве аргументов можно передать массив базовых DN и/или массив фильтров. Количество элементов в массивах должно совпадать с количеством экземпляров LDAP\Connection, поскольку первые записи массивов используются для одного поиска, вторые — для другого и так далее. При параллельном поиске возвращается массив экземпляров LDAP\Result, если только не возникла ошибка, при которой возвращается значение false.

Список параметров

ldap

Экземпляр класса LDAP\Connection, который возвращает функция ldap_connect().

base

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

filter

Пустой фильтр не допустим. Если необходимо получить абсолютно всю информацию для этой записи, используйте фильтр objectClass=*. Если известно какие типы записи используются на сервере каталогов, то можно использовать соответствующий фильтр, такой как objectClass=inetOrgPerson.

attributes

Массив необходимых атрибутов, например, array("mail", "sn", "cn"). Обратите внимание, что "dn" всегда возвращается, независимо от того, какие типы атрибутов требуются.

Использование этого параметра намного более эффективно чем действие по умолчанию (которое возвращает все атрибуты и их присвоенные значения). Поэтому использование этого параметра нужно считать хорошей практикой.

attributes_only

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

sizelimit

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

Замечание:
Этот параметр НЕ может переопределять предустановку sizelimit на стороне сервера. Хотя его можно установить ниже.

Некоторые хосты серверов каталогов будут сконфигурированы так, чтобы возвратить не больше, чем предварительно установленное число записей. Если это произойдёт, то сервер укажет, что только возвратил частичный набор результатов. Это также происходит, если используется этот параметр, чтобы ограничить количество выбранных записей.

timelimit

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

Замечание:
Этот параметр НЕ может переопределять предустановку timelimit на стороне сервера. Хотя его можно установить ниже.

deref

Определяет то, как псевдонимы должны быть обработаны во время поиска. Может быть одним из следующих:

LDAP_DEREF_NEVER — (по умолчанию) псевдонимы никогда не разыменовываются.
LDAP_DEREF_SEARCHING — псевдонимы должны быть разыменованы во время поиска, но не при определении местоположения базового объекта поиска.
LDAP_DEREF_FINDING — псевдонимы должны быть разыменованы при определении местоположения базового объекта, но не во время поиска.
LDAP_DEREF_ALWAYS — псевдонимы должны всегда разыменовываться.

controls

Массив управляющих объектов протокола LDAP для отправки в запросе.

Возвращаемые значения

Возвращает экземпляр класса LDAP\Result, массив экземпляров класса LDAP\Result или false, если возникла ошибка.

Список изменений

Версия	Описание
8.1.0	Параметр `ldap` теперь ожидает экземпляр класса LDAP\Connection; раньше параметр ждал ресурс (resource) `ldap link` .
8.1.0	Возвращает экземпляр класса LDAP\Result; раньше возвращался ресурс (resource).
8.0.0	Параметр `controls` теперь допускает значение null; раньше значение по умолчанию равнялось `[]`.
7.3.0	Добавлена поддержка параметра `controls`

Нашли ошибку?

Инструкция • Исправление • Сообщение об ошибке

＋Добавить

Примечания пользователей 5 notes

down

cnicholl at yahoo dot com ¶

19 years ago

Clarification of the ldap_read command syntax:  If you just want to pull certain attributes from an object and you already know it's dn, the ldap_read command can do this as illustrated below.  It will be less overhead than ldap_search.The string base_dn which is normally used to set the top context for a recursive ldap_search is used slightly differently with this command.  It is used to specify the actual object with the full dn.  (Hopefully this saves someone else a couple hours trying this command out.)<?php$ds = ldap.myserver.com // your ldap server  $dn = "cn=username,o=My Company, c=US"; //the object itself instead of the top search level as in ldap_search  $filter="(objectclass=*)"; // this command requires some filter  $justthese = array("ou", "sn", "givenname", "mail"); //the attributes to pull, which is much more efficient than pulling all attributes if you don't do this      $sr=ldap_read($ds, $dn, $filter, $justthese);          $entry = ldap_get_entries($ds, $sr);echo $entry[0]["mail"][0] . "is the email address of the cn your requested";echo $entry[0]["sn"][0] . "is the sn of the cn your requested";ldap_close($ds);?> This prints out the specified users mail and surname for example.

down

me at example dot com ¶

18 years ago

In the previous example the$ds = ldap.myserver.com // your ldap servershould be $ds = ldap_connect( "ldap.myserver.com" ) ; // your ldap server

down

ronny at nxc dot no ¶

12 years ago

The array in the attributes parameter needs to be an indexed array with numeric keys in ascending order. Like this:Array(    [0] => this    [1] => is    [2] => a    [3] => test)If there are missing keys in the array, then no result will be returned. This will not work:Array(    [0] => this    [1] => is    [3] => test)

down

ehalls at gmail dot com ¶

7 years ago

For those debugging a wrapper, akin to symfony's client wrapper for these functions and since there is crap documentation on a full cycle of pulling a single record vs multiple, etc.For this one:YOU MUST call ldap_get_entries after this function call. AND PLEASE if you implement a wrapper, prime it with the initial entry else it makes no sense to execute without returning something easily visible as successful.WHEN query->execute() and you get a collection.. make sure the entry field in the collection has at least the first entry primed.. wasted so much time because it was looking empty. AND this entire adapter needs to be wrapped with a less retarded usage pattern via an STL lib wrapper, mysticism( bad design) begone.123.. not 4290234~"wdsThanks for your time

down

-1

sbarnum at mac dot com ¶

24 years ago

This differs from ldap_search() by not recursing down to sub-entries.  if you know the dn of the item you're looking for and only want info on that entry, use ldap_read() and pass it the full dn of the item you want.

It also seems that you'd alway want something like objectclass=* for the filter, since you're only searching on one entry.

＋Добавить