Documentation. Finally.

[catagits/Catalyst-Authentication-Store-DBIx-Class.git] / lib / Catalyst / Plugin / Authentication / Store / DBIx / Class / User.pm

diff --git a/lib/Catalyst/Plugin/Authentication/Store/DBIx/Class/User.pm b/lib/Catalyst/Plugin/Authentication/Store/DBIx/Class/User.pm
index 61b46e7..4e5481f 100644 (file)
--- a/lib/Catalyst/Plugin/Authentication/Store/DBIx/Class/User.pm
+++ b/lib/Catalyst/Plugin/Authentication/Store/DBIx/Class/User.pm
@@ -145,16 +145,16 @@ sub get {
     }
 }
 
-sub obj {
+sub get_object {
     my $self = shift;
     
-    return $self->get_object;
+    return $self->_user;
 }
 
-sub get_object {
+sub obj {
     my $self = shift;
     
-    return $self->_user;
+    return $self->get_object;
 }
 
 sub AUTOLOAD {
@@ -170,104 +170,63 @@ __END__
 
 =head1 NAME
 
-Catalyst::Plugin::Authentication::Store::DBIx::Class::User - A class to ...
+Catalyst::Plugin::Authentication::Store::DBIx::Class::User - The backing user
+class for the Catalyst::Plugin::Authentication::Store::DBIx::Class storage
+module.
 
 =head1 VERSION
 
-This documentation refers to version 0.01.
+This documentation refers to version 0.02.
 
 =head1 SYNOPSIS
 
-Internal - not used directly.  use Catalyst::Plugin::Authentication::Store::DBIx::Class::User;
-
+Internal - not used directly, please see
+L<Catalyst::Plugin::Authentication::Store::DBIx::Class> for details on how to
+use this module. If you need more information than is present there, read the
+source.
 
                 
 
 =head1 DESCRIPTION
 
-The Catalyst::Plugin::Authentication::Store::DBIx::Class::User class implements ...
+The Catalyst::Plugin::Authentication::Store::DBIx::Class::User class implements user storage
+connected to an underlying DBIx::Class schema object.
 
 =head1 SUBROUTINES / METHODS
 
-=head2 new (constructor)
-
-Parameters:
-    class
-    authinfo
-    config
-    c
-    lazyload
-
-Insert description of constructor here...
+=head2 new 
 
-=head2 load_user (method)
+Constructor.
 
-Parameters:
-    authinfo
-    c
+=head2 load_user ( $authinfo, $c ) 
 
-Insert description of method here...
+Retrieves a user from storage using the information provided in $authinfo.
 
-=head2 supported_features (method)
+=head2 supported_features
 
-Parameters:
-    none
-
-Insert description of method here...
+Indicates the features supported by this class.  These are currently Roles and Session.
 
 =head2 roles
 
-Parameters:
-    none
-
-Insert description of subroutine here...
+Returns an array of roles associated with this user, if roles are configured for this user class.
 
 =head2 for_session
 
-Parameters:
-    none
+Returns a serialized user for storage in the session.  Currently, this is the value of the field
+specified by the 'id_field' config variable.
 
-Insert description of subroutine here...
+=head2 get ( $fieldname )
 
-=head2 get (method)
+Returns the value of $fieldname for the user in question.  Roughly translates to a call to 
+the DBIx::Class::Row's get_column( $fieldname ) routine.
 
-Parameters:
-    field
+=head2 get_object 
 
-Insert description of method here...
+Retrieves the DBIx::Class object that corresponds to this user
 
 =head2 obj (method)
 
-Parameters:
-    none
-
-Insert description of method here...
-
-=head2 get_object (method)
-
-Parameters:
-    none
-
-Insert description of method here...
-
-=head2 AUTOLOAD (method)
-
-Parameters:
-    none
-
-Insert description of method here...
-
-=head1 DEPENDENCIES
-
-Modules used, version dependencies, core yes/no
-
-strict
-
-warnings
-
-=head1 NOTES
-
-...
+Synonym for get_object
 
 =head1 BUGS AND LIMITATIONS
 
@@ -277,10 +236,10 @@ None known currently, please email the author if you find any.
 
 Jason Kuri (jk@domain.tld)
 
-=head1 LICENCE
-
-Copyright 2006 by Jason Kuri.
+=head1 LICENSE
 
-This software is free.  It is licensed under the same terms as Perl itself.
+Copyright (c) 2007 the aforementioned authors. All rights
+reserved. This program is free software; you can redistribute
+it and/or modify it under the same terms as Perl itself.
 
 =cut