File Coverage

blib/lib/Net/LDAP/Class/Group.pm

Criterion	Covered	Total	%
statement	35	38	92.1
branch	7	10	70.0
condition			n/a
subroutine	11	12	91.6
pod	7	7	100.0
total	60	67	89.5

package Net::LDAP::Class::Group;
use strict;
use warnings;
use Carp;
use base qw( Net::LDAP::Class );
use Net::LDAP::Class::MethodMaker (
    'scalar --get_set_init' => [qw( user_class )],
    'related_objects'       => [qw( primary_users secondary_users  )],

);

our $VERSION = '0.26';

=head1 NAME

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

=head1 SYNOPSIS

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

 # define action_for_* methods for your LDAP schema

 1;

=head1 DESCRIPTION

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

=head1 METHODS

=head2 init

Checks that user_class() is defined.

=cut

sub init {
    my $self = shift;
    $self->SUPER::init(@_);
    unless ( defined $self->user_class ) {
        croak "must define user_class()";
    }
    return $self;
}

=head2 users_iterator([I])

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.

=cut

sub users_iterator {
    my $self = shift;
    return Net::LDAP::Class::MultiIterator->new(
        iterators => [
            $self->primary_users_iterator(@_),
            $self->secondary_users_iterator(@_),
        ]
    );
}

=head2 users

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

B Consider using users_iterator() instead, especially if you
have large groups. See L for an explanation.

=cut

sub users {
    my $self = shift;
    if (@_) {
        croak "users() is an accessor (getter) only";
    }
    my @users = ( @{ $self->primary_users }, @{ $self->secondary_users } );
    return wantarray ? @users : \@users;
}

=head2 has_user( I )

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

B 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 I for addition
with add_to_group().

=cut

sub has_user {
    my $self = shift;
    my $user = shift or croak "User required";

    # don't use the iterator, because we want to look
    # at what might be queued for addition.
    for my $u ( $self->users ) {

        #warn "member $u  <>  user $user";
        if ( "$u" eq "$user" ) {
            return 1;
        }
    }
    return 0;
}

=head2 init_user_class

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

=cut

sub init_user_class {
    croak "Must override init_user_class() or set user_class in metadata. "
        . "Have you created a user subclass yet?";
}

=head2 name

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

=cut

sub name { shift->cn(@_) }

=head2 stringify

Aliased to name().

=cut

sub stringify { shift->name }

1;

__END__