more small changes

[maypole.git] / lib / Maypole / Session.pm

diff --git a/lib/Maypole/Session.pm b/lib/Maypole/Session.pm
index b8b03dc453907ea526e2b1e491ba0abbae62e024..309ff38e601e8fd9bac1959ea399fa63f5dfde82 100644 (file)
--- a/lib/Maypole/Session.pm
+++ b/lib/Maypole/Session.pm
@@ -2,7 +2,7 @@ package Maypole::Session;
 
 =head1 NAME
 
-Maypole::Constants - Maypole predefined constants
+Maypole::Session - Session related functionality for maypole
 
 =head1 SYNOPSIS
 
@@ -14,7 +14,11 @@ my $uid = Maypole::Session::generate_unique_id()
 
 This class provides session related methods for Maypole such as unique id's for requests.
 
-=head1 METHODS
+Currently it provides only the generate_unique_id() function, by checking the id's generated by this function and included in submitted forms, it is possible to see if a form has been submitted before.. implementing these checks is left to the developer of that application.
+
+Further functionality is to be added here in later versions to provide easy access to sessions, either through plugins or builtin methods.
+
+=head1 FUNCTIONS
 
 =head2 generate_unique_id()
 
@@ -26,6 +30,7 @@ generates a unique id and returns it, requires no arguments but accepts size, de
 
 use strict;
 use Digest::MD5;
+our $VERSION = 0.01;
 
 sub generate_unique_id {
     my $length = shift || 32;
@@ -37,6 +42,9 @@ sub generate_unique_id {
 ###################################################################################################
 ###################################################################################################
 
+=head1 TODO
+
+Currently implementing uniqueness tests of form submissions is left to the Maypole user, we plan to provide an optional default behaviour to automate this if required.
 
 =head1 SEE ALSO