Version 1.017
[catagits/Catalyst-Authentication-Store-LDAP.git] / lib / Catalyst / Authentication / Store / LDAP.pm
index 3c74e47..b07cccd 100644 (file)
@@ -3,7 +3,7 @@ package Catalyst::Authentication::Store::LDAP;
 use strict;
 use warnings;
 
-our $VERSION = '1.015';
+our $VERSION = '1.017';
 
 use Catalyst::Authentication::Store::LDAP::Backend;
 
@@ -19,6 +19,8 @@ __END__
 
 =pod
 
+=encoding utf-8
+
 =head1 NAME
 
 Catalyst::Authentication::Store::LDAP
@@ -227,7 +229,7 @@ as identifier for the user.
 
 =head2 user_search_options
 
-This takes a hashref.  It will append it's values to the call to
+This takes a hashref.  It will append its values to the call to
 L<Net::LDAP>'s "search" method during the initial user lookup.  See
 L<Net::LDAP> for valid options.
 
@@ -295,7 +297,7 @@ If this is set to "dn", we will use the User Objects DN.
 
 =head2 role_search_options
 
-This takes a hashref.  It will append it's values to the call to
+This takes a hashref.  It will append its values to the call to
 L<Net::LDAP>'s "search" method during the user's role lookup.  See
 L<Net::LDAP> for valid options.
 
@@ -316,21 +318,25 @@ performed when bound as the user you authenticated as.
 
 =head2 persist_in_session
 
-Can take one of the following values, defaults to undefined:
+Can take one of the following values, defaults to C<username>:
+
+=over
 
-=head3 undefined
+=item C<username>
 
 Only store the username in the session and lookup the user and its roles
 on every request. That was how the module worked until version 1.015 and is
 also the default for backwards compatibility.
 
-=head3 all
+=item C<all>
 
 Store the user object and its roles in the session and never look it up in
 the store after login.
 
 B<NOTE:> It's recommended to limit the user attributes fetched from LDAP
-using L<user_search_options> / attrs to not exhaust the session store..
+using L</user_search_options> / C<attrs> to not exhaust the session store.
+
+=back
 
 =head2 entry_class
 
@@ -352,11 +358,13 @@ L<Catalyst::Plugin::Authentication/default_auth_store> with this object.
 =head1 AUTHORS
 
 Adam Jacob <holoway@cpan.org>
+Peter Karman <karman@cpan.org>
+Alexander Hartmaier <abraxxa@cpan.org>
 
 Some parts stolen shamelessly and entirely from
 L<Catalyst::Plugin::Authentication::Store::Htpasswd>.
 
-Currently maintained by Peter Karman <karman@cpan.org>.
+Currently maintained by Dagfinn Ilmari MannsÃ¥ker <ilmari@cpan.org>.
 
 =head1 THANKS