Add obj() as shorthand method for get_object()
Jay Kuri [Sat, 28 Mar 2009 01:43:46 +0000 (01:43 +0000)]
Remove warning about storage if an alternate realm is being used.

lib/Catalyst/Authentication/Realm.pm
lib/Catalyst/Authentication/User.pm

index 5c31034..550da39 100644 (file)
@@ -29,8 +29,9 @@ sub new {
 
     $app->log->debug("Setting up auth realm $realmname") if $app->debug;
 
-    # use the Null store as a default
-    if( ! exists $config->{store}{class} ) {
+    # use the Null store as a default - Don't complain if the realm class is being overridden, 
+    # as the new realm may behave differently.
+    if( ! exists($config->{store}{class}) && ! exists($config->{class}) ) {
         $config->{store}{class} = '+Catalyst::Authentication::Store::Null';
         $app->log->debug( qq(No Store specified for realm "$realmname", using the Null store.) );
     } 
index 8d811bc..5270d39 100644 (file)
@@ -64,6 +64,13 @@ sub get_object {
     return shift;
 }
 
+## obj is shorthand for get_object.  This is originally from the DBIx::Class store, but 
+## as it has become common usage, this makes things more compatible.  Plus, it's shorter.
+sub obj {
+    my $self = shift;
+    return $self->get_object(@_);
+}
+
 ## Backwards Compatibility
 ## you probably want auth_realm, in fact.  but this does work for backwards compatibility.
 ## store should be a read-write accessor - so it was moved to mk_accessors
@@ -106,9 +113,18 @@ ID.
 
 An introspection method used to determine what features a user object has, to support credential and authorization plugins.
 
-=head2 get( )
+=head2 get( $field )
+
+Returns the value for the $field provided.
 
 =head2 get_object( )
 
+Returns the underlying object storing the user data.  The return value of this function will vary depending
+on the storage module used.
+
+=head2 obj( )
+
+Shorthand for get_object( )
+
 =cut