NAME

Net::LDAP::Control::Sort - LDAPv3 sort control object

SYNOPSIS

 use Net::LDAP::Control::Sort;
 use Net::LDAP::Constant qw(LDAP_CONTROL_SORTRESULT);

 $sort = Net::LDAP::Control::Sort->new(
   order => "cn -phone"
 );

 $mesg = $ldap->search( @args, control => [ $sort ]);

 ($resp) = $mesg->control( LDAP_CONTROL_SORTRESULT );

 print "Results are sorted\n" if $resp and !$resp->result;

DESCRIPTION

Net::LDAP::Control::Sort is a sub-class of Net::LDAP::Control. It provides a class for manipulating the LDAP sort request control 1.2.840.113556.1.4.473

If the server supports sorting, then the response from a search operation will include a sort result control. This control is handled by Net::LDAP::Control::SortResult.

CONSTRUCTOR ARGUMENTS

order

order may be a string or a reference to an array. If it is a string it is split on whitespace, otherwise the contents of the array is used.

Each element in the array specifies a sorting order as follows

  -attributeType:orderingRule

The leading - is optional, and if present indicates that the sorting order should be reversed. attributeType is the attribute name to sort by. orderingRule is optional and indicates the rule to use for the sort and should be valid for the given attributeType.

Any one attributeType should only appear once in the sorting list.

METHODS

Net::LDAP::Control::Sort provides the following methods in addition to those defined by Net::LDAP::Control

order [ ORDER ]

ORDER may be a string or a list. If it is a string then it is split on whitespace and treated as if a list had been passed. See order above for a description of the format for each element.

If no arguments are passed then a list is returned of the current ordering elements.

SEE ALSO

Net::LDAP, Net::LDAP::Control::SortResult, Net::LDAP::Control

AUTHOR

Graham Barr <gbarr@pobox.com>

Please report any bugs, or post any suggestions, to the perl-ldap mailing list <perl-ldap-dev@lists.sourceforge.net>

COPYRIGHT

Copyright (c) 1999-2000 Graham Barr. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

$Id: //depot/ldap/lib/Net/LDAP/Control/Sort.pm#4 $