some pod fixes

This commit is contained in:
JT Smith 2005-09-01 17:51:01 +00:00
parent 4fabaa5d5b
commit 1e3b8eb4ec

View file

@ -46,13 +46,16 @@ These subroutines are available from this package:
=cut
#-------------------------------------------------------------------
=head2 bind ( )
Authenticates against the ldap server with the parameters stored in the class, returning a valid ldap connection, or 0 if a connection
cannot be established
=cut
#-------------------------------------------------------------------
sub bind {
my $class = shift;
my ($uri, $ldap, $auth, $result, $error);
@ -103,10 +106,10 @@ sub DESTROY {
}
#-------------------------------------------------------------------
=head2 getErrorMessage ( [ldapErrorCode] )
Returns the error string representing the error code generated by Net::LDAP. If no code is passed in,
the most recent error stored by the class is returned
Returns the error string representing the error code generated by Net::LDAP. If no code is passed in, the most recent error stored by the class is returned
=head3 ldapErrorCode
@ -123,6 +126,7 @@ sub getErrorMessage {
}
#-------------------------------------------------------------------
=head2 getList ( )
Returns a hash reference containing all ldap links. The format is:
@ -138,6 +142,7 @@ sub getList {
}
#-------------------------------------------------------------------
=head2 get ( ldapLinkId )
Returns a hashRef containing a single ldap link.
@ -156,6 +161,7 @@ sub get {
}
#-------------------------------------------------------------------
=head2 unbind ( )
Disconnect cleanly from the current databaseLink.
@ -193,6 +199,7 @@ sub new {
}
#-------------------------------------------------------------------
=head2 getProperty(dn,property)
Returns the results of a search on the property passed in
@ -227,45 +234,7 @@ sub getProperty {
}
#-------------------------------------------------------------------
=head2 getRecursiveProperty(dn,property[,recursiveProperty])
Returns the results of a search on the property passed in
=head3 distinguished name of property
distinguished name of group to check users for
=head3 property
ldap property to retrieve from distinguished name
=head3 recursiveProperty
property to recursively search. If no recursive property is passed, the
=cut
#sub getRecursiveProperty {
# my $self = shift;
# my $ldap = $self->bind;
# my $dn = $_[0];
# my $property = $_[1];
# my $recProp = $_[2] || $property;
# return [] unless($ldap && $dn && $property);
# my $results = [];
# my $msg = $ldap->search(
# base => $dn,
# scope => 'sub',
# filter => "&(objectClass=*)"
# );
# if(!$msg->code && $msg->count > 0 ){
# my $entry = $msg->entry(($msg->count)-1);
# $self->recurseProperty($entry,$users,$property,$recProp,0);
# }
# return $results;
#}
#-------------------------------------------------------------------
=head2 recurseProperty(base,array,property,alternateKey)
Returns the whether or not the user is in a particular group