bunch more docs
[catagits/Web-Session.git] / lib / Plack / Session / Store / Null.pm
1 package Plack::Session::Store::Null;
2 use strict;
3 use warnings;
4
5 sub new     { bless {} => shift }
6 sub fetch   {}
7 sub store   {}
8 sub delete  {}
9 sub cleanup {}
10 sub persist {}
11
12 1;
13
14 __END__
15
16 =pod
17
18 =head1 NAME
19
20 Plack::Session::Store::Null - Null store
21
22 =head1 SYNOPSIS
23
24   use Plack::Builder;
25   use Plack::Middleware::Session;
26   use Plack::Session::Store::Null;
27
28   my $app = sub {
29       return [ 200, [ 'Content-Type' => 'text/plain' ], [ 'Hello Foo' ] ];
30   };
31
32   builder {
33       enable 'Session',
34           store => Plack::Session::Store::Null->new;
35       $app;
36   };
37
38 =head1 DESCRIPTION
39
40 Sometimes you don't want to store anything in your sessions, but
41 L<Plack::Session> requires a C<store> instance, so you can use this
42 one and all methods will return null.
43
44 This is a subclass of L<Plack::Session::Store> and implements
45 it's full interface.
46
47 =head1 BUGS
48
49 All complex software has bugs lurking in it, and this module is no
50 exception. If you find a bug please either email me, or add the bug
51 to cpan-RT.
52
53 =head1 AUTHOR
54
55 Stevan Little E<lt>stevan.little@iinteractive.comE<gt>
56
57 =head1 COPYRIGHT AND LICENSE
58
59 Copyright 2009 Infinity Interactive, Inc.
60
61 L<http://www.iinteractive.com>
62
63 This library is free software; you can redistribute it and/or modify
64 it under the same terms as Perl itself.
65
66 =cut
67