Peter Karman > Net-LDAP-Class-0.26 > Net::LDAP::Class::MultiIterator

Download:
Net-LDAP-Class-0.26.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.26   Source  

NAME ^

Net::LDAP::Class::MultiIterator - a set of Net::LDAP::Class::Iterator objects

SYNOPSIS ^

 my $iterator = $user->groups_iterator;
 while ( my $group = $iterator->next ) {
    # $group isa Net::LDAP::Class::Group
 }
 printf("%d groups found\n", $iterator->count);

DESCRIPTION ^

Net::LDAP::Class::MultiIterator handles multiple iterators under a single call to next(). Used by users_iterator() and groups_iterator() methods.

METHODS ^

iterators

The array ref of iterators. Required to be set in new().

init

Set up the object.

count

Returns the total number of iterations.

next

Return the next result. If one iterator on the stack is exhausted, automatically moves to the next one.

is_exhausted

Returns true (1) if all the internal iterators return is_exhausted, false (undef) otherwise.

finish

Calls finish() on all un-exhausted iterators.

AUTHOR ^

Peter Karman, <karman at cpan.org>

BUGS ^

Please report any bugs or feature requests to bug-net-ldap-class at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-LDAP-Class. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc Net::LDAP::Class

You can also look for information at:

COPYRIGHT ^

Copyright 2009 by Peter Karman.

All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO ^

Net::LDAP, Net::LDAP::Batch

syntax highlighting: