[Jifty-commit] r3580 - in jifty/trunk: lib/Jifty/Plugin lib/Jifty/Plugin/User/Mixin/Model

[jifty-commit at lists.jifty.org]

Author: sterling
Date: Wed Jun 27 21:43:41 2007
New Revision: 3580

Modified:
   jifty/trunk/   (props changed)
   jifty/trunk/lib/Jifty/Plugin/User.pm
   jifty/trunk/lib/Jifty/Plugin/User/Mixin/Model/User.pm

Log:
 r7874 at dynpc145:  andrew | 2007-06-27 20:42:34 -0500
 Fleshing out and cleaning up the documentation for Jifty::Plugin::User.


Modified: jifty/trunk/lib/Jifty/Plugin/User.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Plugin/User.pm	(original)
+++ jifty/trunk/lib/Jifty/Plugin/User.pm	Wed Jun 27 21:43:41 2007
@@ -4,18 +4,22 @@
 package Jifty::Plugin::User;
 use base qw/Jifty::Plugin/;
 
-# Your plugin goes here.  If takes any configuration or arguments, you
-# probably want to override L<Jifty::Plugin/init>.
-
 =head1 NAME
 
-Jifty::Plugin::User
+Jifty::Plugin::User - plugin for building user models
 
 =head1 DESCRIPTION
 
 This plugin provides a "user" mixin for your application's user model class.
 
-See L<Jifty::Plugin::User/> for more details.
+=head1 SEE ALSO
+
+L<Jifty::Plugin::User::Mixin::Model::User>, L<Jifty::Plugin::Authentication::Password>
+
+=head1 LICENSE
+
+Jifty is Copyright 2005-2007 Best Practical Solutions, LLC.
+Jifty is distributed under the same terms as Perl itself.
 
 =cut
 

Modified: jifty/trunk/lib/Jifty/Plugin/User/Mixin/Model/User.pm
==============================================================================
--- jifty/trunk/lib/Jifty/Plugin/User/Mixin/Model/User.pm	(original)
+++ jifty/trunk/lib/Jifty/Plugin/User/Mixin/Model/User.pm	Wed Jun 27 21:43:41 2007
@@ -7,9 +7,9 @@
 
 =head1 NAME
 
-Jifty::Plugin::User::Mixin::Model::User
+Jifty::Plugin::User::Mixin::Model::User - user model base mixin
 
-=head1 DESCRIPTION
+=head1 SYNOPSIS
 
  package MyApp::Model::User;
  use Jifty::DBI::Schema;
@@ -18,8 +18,27 @@
  };
  
  use Jifty::Plugin::User::Mixin::Model::User; # Imports two columns: name and email
- 
 
+=head1 DESCRIPTION
+
+This mixin may be added to a model to give your user accounts a name and an email address. This module may be used as the basic building block for building account models in your application. It can be combined with mixins from an authentication plugin to create an object suitable for a given authentication mechanism.
+
+=head1 SCHEMA
+
+This mixin model adds the following columns to the model.
+
+=head2 name
+
+This is the username/nickname for the user of the account.
+
+=head2 email
+
+This is the email address of the account. It is intended as a bare minimum confirmation of identity and for communication of password resets and other account information.
+
+=head2 email_confirmed
+
+This is a flag indicating whether the user has confirmed ownership of the given email address.
+ 
 =cut
 
 use base 'Jifty::DBI::Record::Plugin';
@@ -37,9 +56,7 @@
 
 };
 
-# Your model-specific methods go here.
-
-
+=head1 METHODS
 
 =head2 set_email ADDRESS
 
@@ -92,6 +109,16 @@
     return 1;
 }
 
+=head1 SEE ALSO
+
+L<Jifty::Plugin::Authentication::Password>, L<Jifty::Plugin::Authentication::Password::Mixin::Model::User>
+
+=head1 LICENSE
+
+Jifty is Copyright 2005-2007 Best Practical Solutions, LLC.
+Jifty is distributed under the same terms as Perl itself.
+
+=cut
 
 1;