Net::LDAP::Class::Group(3)

NAME
Net::LDAP::Class::Group - base class for LDAP group objects

SYNOPSIS
 package MyGroup;
 use strict;
 use base qw( Net::LDAP::Class::Group );

 # define action_for_* methods for your LDAP schema

 1;

DESCRIPTION
Net::LDAP::Class::Group is a simple base class intended to be subclassed by schema-specific Net::LDAP::Class::Group::* classes.

METHODS

  init
Checks that user_class() is defined.

  users_iterator([opts_hashref])
Returns a Net::LDAP::Class::MultiIterator object for all primary and secondary users.

This is the same data as users() returns, but is more efficient since it pages the results and only fetches one at a time.

  users
Returns array or array ref (based on context) of primary_users() and secondary_users().

CAUTION: Consider using users_iterator() instead, especially if you have large groups. See Net::LDAP::Class::Iterator for an explanation.

  has_user( user )
Returns true if user is amongst users(), false otherwise.

NOTE: This looks at the currently loaded users() and does not do a read of the LDAP server. It is mostly useful for checking whether you've already queued user for addition with add_to_group().

  init_user_class
Override this method in your subclass to set the default User class for your Group class.

  name
Same as calling cn(). A Group object stringifies to this method.

  stringify
Aliased to name().

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:

•   AnnoCPAN: Annotated CPAN documentation

    <http://annocpan.org/dist/Net-LDAP-Class>

•   CPAN Ratings

    <http://cpanratings.perl.org/d/Net-LDAP-Class>

•   RT: CPAN's request tracker

    <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Net-LDAP-Class>

•   Search CPAN

    <http://search.cpan.org/dist/Net-LDAP-Class>

ACKNOWLEDGEMENTS
The Minnesota Supercomputing Institute "http://www.msi.umn.edu/" sponsored the development of this software.

COPYRIGHT
Copyright 2008 by the Regents of the University of Minnesota. 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::Class