ldap_control_paged_result_response
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.
ldap_control_paged_result
(PHP 5 >= 5.4.0)
ldap_control_paged_result — Envoi un contrôle de pagination LDAP
Description
bool ldap_control_paged_result
( resource
$link
, int $pagesize
[, bool $iscritical = false
[, string $cookie = ""
]] )Active la pagination LDAP en envoyant le contrôle de pagination (taille de la page, cookie,...).
Liste de paramètres
-
link -
Un identifiant de lien LDAP, retourné par la fonction ldap_connect().
-
pagesize -
Le nombre d'entrées par page.
-
iscritical -
Indique si la pagination est critique ou non. Si vaut
TRUE, et si le serveur ne supporte pas la pagination, la recherche ne retournera aucun résultat. -
cookie -
Une structure opaque envoyée par le serveur ( ldap_control_paged_result_response()).
Valeurs de retour
Cette fonction retourne TRUE en cas de
succès ou FALSE si une erreur survient.
Exemples
L'exemple ci-dessous montre la manière pour récupérer la première page d'une recherche paginée avec une seule entrée par page.
Exemple #1 Pagination LDAP
<?php
// $ds est un identifiant de lien valide (voir 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');
// active la pagination avec une taille de page à 1.
ldap_control_paged_result($ds, 1);
$sr = ldap_search($ds, $dn, $filter, $justthese);
$info = ldap_get_entries($ds, $sr);
echo $info['count'] . ' entrées retournées' . PHP_EOL;
L'exemple ci-dessous montre la manière pour récupérer tous les résultats paginés avec 100 entrées par page.
Exemple #2 Pagination LDAP
<?php
// $ds est un identifiant de lien valide (voir 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');
// active la pagination avec une taille de page à 100.
$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 != '');
Notes
Note:
Le contrôle de la pagination est une fonctionalité du protocole LDAPv3.
Voir aussi
- ldap_control_paged_result_response() - Récupère le cookie de pagination LDAP
- » RFC2696 : Extension de contrôle LDAP pour une manipulation simplifiée des résultats paginés
add a note
User Contributed Notes
ldap_control_paged_result - [3 notes]
jestertrance at hotmail dot com ¶
2 months ago
etienne at lamaisondebarbie dot ch ¶
1 year ago
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.
James ¶
1 year ago
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.