(PHP 5 >= 5.4.0, PHP 7)
ldap_control_paged_result — Послать серверу LDAP данные для использования постраничного извлечения результата
Функция УСТАРЕЛА с PHP 7.4.0
а в PHP 8.0.0 функцию УДАЛИЛИ.
Вместо этой функции вызывают функцию ldap_search()
с передачей в параметр controls
управляющих объектов протокола LDAP.
Раздел «Управляющие объекты LDAP»
даёт дополнительную информацию.
$link,$pagesize,$iscritical = false,$cookie = ""Разрешает работу с LDAP в постраничном режиме, путём отправки желаемых настроек (размер страницы, куки и т.д.)
linkРесурс LDAP, возвращаемый функцией ldap_connect().
pagesizeКоличество записей на страницу.
iscritical
Определяет, является ли постраничный режим критичным или нет.
Если true и если сервер не поддерживает постраничную работу,
поиск вернёт пустой результат.
cookieНепрозрачная структура, посылаемая сервером (ldap_control_paged_result_response()).
Функция возвращает true в случае успешного выполнения или false, если возникла ошибка.
| Версия | Описание |
|---|---|
| 8.0.0 | Функция была удалена. |
| 7.4.0 | Функция объявлена устаревшей. |
Пример ниже демонстрирует извлечение первой страницы результата поиска с использованием размера страницы равного одной записи.
Пример #1 Постраничная работа с LDAP
<?php
// $ds - идентификатор соединения (смотрите ldap_connect)
ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3);
$dn = 'ou=example,dc=org';
$filter = '(|(sn=Doe*)(givenname=John*))';
$justthese = array('ou', 'sn', 'givenname', 'mail');
// разрешаем постраничную работу с размером страницы равному одной записи.
ldap_control_paged_result($ds, 1);
$sr = ldap_search($ds, $dn, $filter, $justthese);
$info = ldap_get_entries($ds, $sr);
echo $info['count'] . ' записей возвращено' . PHP_EOL;Пример ниже демонстрирует извлечение первой страницы результата поиска с использованием размера страницы равного ста записям.
Пример #2 Постраничная работа с LDAP
<?php
// $ds - идентификатор соединения (смотрите ldap_connect)
ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3);
$dn = 'ou=example,dc=org';
$filter = '(|(sn=Doe*)(givenname=John*))';
$justthese = array('ou', 'sn', 'givenname', 'mail');
// разрешаем постраничную работу с размером страницы равному ста записям.
$pageSize = 100;
$cookie = '';
do {
ldap_control_paged_result($ds, $pageSize, true, $cookie);
$result = ldap_search($ds, $dn, $filter, $justthese);
$entries = ldap_get_entries($ds, $result);
foreach ($entries as $e) {
echo $e['dn'] . PHP_EOL;
}
ldap_control_paged_result_response($ds, $result, $cookie);
} while($cookie !== null && $cookie != '');Замечание:
Постраничный режим появился в версии протокола LDAPv3.
I was able to get these functions to work successfully with Active Directory. When I first tried it, ldap_search kept returning a Not Supported reply from the server. I finally figured out that I needed to include
ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3);
in my code, so that AD would let me page results. Make sure you're using a compatible protocol.
Hope this note helps someone else.If you did a paged search operation and want to do any other read operation on LDAP, you need to reset it, otherwise you will experience LDAP errors (code 12, for instance).
<?php
…
ldap_control_paged_result($link, 0);
…
?>You may need to do an ldap_bind before running ldap_control_paged_result to get this to work:
$conn = ldap_connect("you_ip");
ldap_set_option($conn, LDAP_OPT_PROTOCOL_VERSION, 3);
ldap_bind("your_connection_info");
ldap_control_paged_result($conn, $pageSize, true, $cookie)
Without doing an ldap_bind, I kept getting the error "Critical extension is unavailable". I don't if this is standard knowledge, but knowing this would have saved me days of frustration.While another note suggests resetting the control paged result by passing in `0` (zero), it actually still prevents any further queries being ran during the same request.
You actually need to set it to a large number to run further queries it seems. For example:
<?php
ldap_control_paged_result($connection, 100, true, $cookie);
// Run the search
...
// What is supposed to work (reset)
ldap_control_paged_result($connection, 0, false, $cookie);
// What actually works
ldap_control_paged_result($connection, 1000, false, $cookie);
?>
In the above method, 1000 is just a placeholder, but this seems to actually **limit** further queries to this amount of results, so if you set it to `1`, then you'll only receive **one** result for any further queries during the same request.Paged results, as specified in the RFC 2696, does not allow to get over the server sizeLimit. The RFC clearly states "If the page size is greater than or equal to the sizeLimit value, the server should ignore the control as the request can be satisfied in a single page".
With OpenLDAP, you will not get more than the sizeLimit number of entries with paged results.So how do you now sort the entire result? It appears you can't use ldap_sort as it uses the search resource which is within the loop.