ldap_search — Выполняет поиск по LDAP-дереву

Назначение ldap_search

ldap_search: Выполняет поиск по LDAP-дереву. Справочная сущность относится к разделу «ldap». Используйте её, когда это краткое назначение совпадает с задачей приложения; фактическое поведение подтверждайте сигнатурой и проверочным сценарием ниже.

Чем отличается ldap_search

Это процедурная функция раздела «ldap». Её отличают имя ldap_search, контракт «обязательные $ldap, $base, $filter; необязательные $attributes, $attributes_only, $sizelimit, $timelimit, $deref, $controls» и объявленный результат LDAP\Result|array|false; эти три признака нужно сверять вместе при выборе похожего API.

Смысловое направление ldap_search

Смысловое направление ldap_search — «поиск или сопоставление». В прикладном коде заранее определите смысл отсутствия совпадения и форму позиции или найденного значения. Контрольный набор для этой операции: проверьте первое, последнее и отсутствующее совпадение. Такой акцент отделяет ldap_search от API с похожей сигнатурой, но противоположным действием или другим жизненным циклом.

Сигнатура ldap_search

Структурная запись: LDAP\Result|array|false ldap_search(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|null $controls = null). В ней 9 параметров: обязательные $ldap, $base, $filter; необязательные $attributes, $attributes_only, $sizelimit, $timelimit, $deref, $controls. Результат объявлен как LDAP\Result|array|false; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры ldap_search

Порядок и роли аргументов по сигнатуре: 1. $ldap — LDAP\Connection|array, обязателен; 2. $base — array|string, обязателен; 3. $filter — array|string, обязателен; 4. $attributes — array, необязателен, default []; 5. $attributes_only — int, необязателен, default 0; 6. $sizelimit — int, необязателен, default -1; 7. $timelimit — int, необязателен, default -1; 8. $deref — int, необязателен, default LDAP_DEREF_NEVER; 9. $controls — array|null, необязателен, default null.

Контроль входных данных для ldap_search

1) LDAP\Connection|array $ldap — обязательный: подтвердите тип и открытое состояние ресурса, затем проверьте вызов после его закрытия. 2) array|string $base — обязательный: разведите тесты для пустого набора, одного элемента и неоднородных значений. 3) array|string $filter — обязательный: разведите тесты для пустого набора, одного элемента и неоднородных значений. 4) array $attributes — необязательный: разведите тесты для пустого набора, одного элемента и неоднородных значений. 5) int $attributes_only — необязательный: проверьте минимальное, типичное и предельное числовое значение без неявного преобразования строки. 6) int $sizelimit — необязательный: проверьте ноль, границу диапазона и значение за пределами входной структуры. 7) int $timelimit — необязательный: проверьте ноль, границу диапазона и значение за пределами входной структуры. Оставшиеся 2 параметра проверяйте по тем же правилам типа, обязательности и значения по умолчанию.

Результат ldap_search

ldap_search объявляет результат типа LDAP\Result|array|false. Контракт ldap_search допускает false: проверяйте этот исход строгим сравнением === false, чтобы не спутать его с 0, пустой строкой или пустым массивом.

Проверочный сценарий для ldap_search

Убедитесь, что раздел «ldap» доступен в целевой сборке PHP. Сначала выполните контрольный вызов с обязательным набором 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|null $controls=null, чтобы увидеть влияние значений по умолчанию. Для профиля «сетевое взаимодействие» важно задавать таймауты и не считать транспортный успех бизнес-успехом; негативный сценарий должен проверить таймаут, недоступный узел и некорректный ответ.

Интеграция ldap_search в проект

Проверку доступности ldap_search и преобразование входных значений разместите у границы модуля «ldap». Для профиля «сетевое взаимодействие» вынесите обработку отказа в одну ветку и добавьте к журналу имя операции, версию PHP и безопасные метаданные входа. Не применяйте оператор @: он скрывает диагностический сигнал, необходимый для разбора сбоя. Повторный вызов разрешайте только после явной проверки, что операция ldap_search не создаёт нежелательный повторный эффект в вашем сценарии.

Диагностика ldap_search

Сначала запишите точную сигнатуру LDAP\Result|array|false ldap_search(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|null $controls = null) и фактические типы переданных значений. Затем подтвердите загрузку расширения «ldap» в той же среде, где выполняется ldap_search. Документация описывает ошибочный исход: отделите его от корректного пустого значения строгой проверкой и сохраните исходную диагностику. Для ldap_search предусмотрите отдельный тест ветки false; не смешивайте её с 0 или пустой строкой.

Границы применения

Для категории «сетевое взаимодействие» применяйте отдельный негативный тест: проверить таймаут, недоступный узел и некорректный ответ. В production-коде важно задавать таймауты и не считать транспортный успех бизнес-успехом. Исходные предупреждения и примечания не копируются на эту страницу: перед решением, влияющим на совместимость или безопасность, сверяйте поведение в целевой версии PHP.

Когда выбирать ldap_search

Выбор ldap_search оправдан, когда одновременно выполнены три условия: 1) в сборке доступно расширение «ldap»; 2) сигнатура содержит 9 аргументов: обязательных 3, необязательных 6; 3) вызывающему коду нужен результат LDAP\Result|array|false и действие «поиск или сопоставление». Для профиля «сетевое взаимодействие» до интеграции отдельно подтвердите применимость правила: «undefined». Если хотя бы один пункт не выполняется, сравните контракт с ldap_list: у него другое назначение, владелец или набор входных данных.

Сравнение ldap_search с соседними API

Для ldap_search базовый ориентир: выполняет поиск по ldap-дереву; обязательные $ldap, $base, $filter; необязательные $attributes, $attributes_only, $sizelimit, $timelimit, $deref, $controls; результат LDAP\Result|array|false. Сопоставление с опубликованными соседями: ldap_list: выполняет одноуровневый поиск; вход — обязательные $ldap, $base, $filter; необязательные $attributes, $attributes_only, $sizelimit, $timelimit, $deref, $controls; результат — LDAP\Result|array|false. ldap_get_entries: получает все записи результата; вход — обязательные $ldap, $result; результат — array|false. ldap_add_ext: добавить записи в каталог ldap; вход — обязательные $ldap, $dn, $entry; необязательные $controls; результат — LDAP\Result|false. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

Версии и ограничения

В структурной истории исходной записи отмечены версии: 7.3.0. ldap_search сверена по закреплённой ревизии php/doc-ru. Перед обновлением PHP повторите тесты типов, предупреждений и граничных значений для этой сущности. Не переносите выводы между версиями без повторного запуска минимального воспроизводимого примера для ldap_search.

Связанные материалы