[Catalyst-commits] r6503 - trunk/Catalyst-Plugin-Session-DynamicExpiry/lib/Catalyst/Plugin/Session

[nothingmuch at dev.catalyst.perl.org]

Author: nothingmuch
Date: 2007-07-04 21:53:25 +0100 (Wed, 04 Jul 2007)
New Revision: 6503

Modified:
   trunk/Catalyst-Plugin-Session-DynamicExpiry/lib/Catalyst/Plugin/Session/DynamicExpiry.pm
Log:
foo

Modified: trunk/Catalyst-Plugin-Session-DynamicExpiry/lib/Catalyst/Plugin/Session/DynamicExpiry.pm
===================================================================
--- trunk/Catalyst-Plugin-Session-DynamicExpiry/lib/Catalyst/Plugin/Session/DynamicExpiry.pm	2007-07-03 15:18:39 UTC (rev 6502)
+++ trunk/Catalyst-Plugin-Session-DynamicExpiry/lib/Catalyst/Plugin/Session/DynamicExpiry.pm	2007-07-04 20:53:25 UTC (rev 6503)
@@ -62,7 +62,15 @@
 =head1 SYNOPSIS
 
     # put Session::DynamicExpiry in your use Catalyst line
+    # note that for this plugin to work it must appear before the Session
+    # plugin, since it overrides some of that plugin's methods.
     
+    use Catalyst qw/ ...
+
+        Session::DynamicExpiry
+        Session
+    /;
+    
     if ($c->req->param('remember') { 
       $c->session_time_to_live( 604800 ) # expire in one week.
     }
@@ -98,6 +106,12 @@
 
 Overridden to implement dynamic expiry functionality.
 
+=head1 CAVEATS
+
+When it just doesn't work, it's usually because you put it after
+L<Catalyst::Plugin::Session> in the plugin list. It must go before it so that
+it can override L<Catalyst::Plugin::Session>'s methods.
+
 =head1 SEE ALSO
 
 =head2 L<Catalyst::Plugin::Session> - The new session framework.