[Catalyst-commits] r7059 - trunk/Catalyst-Plugin-Authentication/lib/Catalyst/Plugin/Authentication

[bricas at dev.catalyst.perl.org]

Author: bricas
Date: 2007-10-25 19:57:25 +0100 (Thu, 25 Oct 2007)
New Revision: 7059

Modified:
   trunk/Catalyst-Plugin-Authentication/lib/Catalyst/Plugin/Authentication/Realm.pm
Log:
add docs to realm class

Modified: trunk/Catalyst-Plugin-Authentication/lib/Catalyst/Plugin/Authentication/Realm.pm
===================================================================
--- trunk/Catalyst-Plugin-Authentication/lib/Catalyst/Plugin/Authentication/Realm.pm	2007-10-25 16:14:43 UTC (rev 7058)
+++ trunk/Catalyst-Plugin-Authentication/lib/Catalyst/Plugin/Authentication/Realm.pm	2007-10-25 18:57:25 UTC (rev 7059)
@@ -150,24 +150,52 @@
 
 =item class
 
+By default this class is the default realm class. You can specify a custom
+realm class with this config parameter.
+
 =item auto_create_user
 
+Set this to true if you wish this realm to auto-create user accounts when the
+user doesn't exist (most useful for remote authentication schemes).
+
 =item auto_update_user
 
+Set this to true if you wish this realm to auto-update user accounts after
+authentication (most useful for remote authentication schemes).
+
 =back
 
 =head1 METHODS
 
 =head2 new( )
 
+Instantiantes this realm, plus the specified store and credential classes.
+
+=head2 store( )
+
+Holds an instance of the store object for this realm.
+
+=head2 credential( )
+
+Holds an instance of the credential object for this realm.
+
 =head2 find_user( )
 
+Delegates to the store object. Will also re-delegate auto_create_user and
+auto_update_user at this time, if necessary.
+
 =head2 authenticate( )
 
+Delegates to the credential objects and sets the authenticated user on success.
+
 =head2 save_user_in_session( )
 
+Delegates to the store object.
+
 =head2 from_session( )
 
+Delegates to the store object.
+
 =back
 
 =cut