1Catalyst::Plugin::SessiUosne:r:SCtoonrter:i:bFuitleedC(a3Pt)earllysDto:c:uPmleungtiant:i:oSnession::Store::File(3)
2
3
4

NAME

6       Catalyst::Plugin::Session::Store::File - File storage backend for
7       session data.
8

SYNOPSIS

10           use Catalyst qw/Session Session::Store::File Session::State::Foo/;
11
12           MyApp->config->{'Plugin::Session'} = {
13               storage => '/tmp/session'
14           };
15
16           # ... in an action:
17           $c->session->{foo} = 'bar'; # will be saved
18

DESCRIPTION

20       "Catalyst::Plugin::Session::Store::File" is an easy to use storage
21       plugin for Catalyst that uses an simple file to act as a shared memory
22       interprocess cache. It is based on "Cache::FileCache".
23
24   METHODS
25       get_session_data
26       store_session_data
27       delete_session_data
28       delete_expired_sessions
29           These are implementations of the required methods for a store. See
30           Catalyst::Plugin::Session::Store.
31
32       setup_session
33           Sets up the session cache file.
34

CONFIGURATION

36       These parameters are placed in the hash under the "Plugin::Session" key
37       in the configuration hash.
38
39       storage
40           Specifies the directory root to be used for the sharing of session
41           data. The default value will use File::Spec to find the default
42           tempdir, and use a file named "MyApp/session/data", where "MyApp"
43           is replaced with the appname.
44
45           Note that the file will be created with mode 0640, which means that
46           it will only be writeable by processes running with the same uid as
47           the process that creates the file.  If this may be a problem, for
48           example if you may try to debug the program as one user and run it
49           as another, specify a directory like "/tmp/session-$>", which
50           includes the UID of the process in the filename.
51
52       relative
53           Makes the storage path relative to $c-path_to>
54
55       namespace
56           The namespace associated with this cache. Defaults to an empty
57           string if not explicitly set.  If set, the session data will be
58           stored in a directory called "MyApp/session/data/<namespace">.
59
60       cache_depth
61           The number of subdirectories deep to session object item. This
62           should be large enough that no session directory has more than a
63           few hundred objects. Defaults to 3 unless explicitly set.
64
65       directory_umask
66           The directories in the session on the filesystem should be globally
67           writable to allow for multiple users. While this is a potential
68           security concern, the actual cache entries are written with the
69           user's umask, thus reducing the risk of cache poisoning. If you
70           desire it to only be user writable, set the 'directory_umask'
71           option to '077' or similar. Defaults to '000' unless explicitly
72           set.
73

SEE ALSO

75       Catalyst, Catalyst::Plugin::Session, Cache::FileCache.
76

AUTHOR

78       Sascha Kiefer, esskar@cpan.org
79

81       Copyright (C) 2005 Sascha Kiefer
82
83       This library is free software; you can redistribute it and/or modify it
84       under the same terms as Perl itself.
85
86
87
88perl v5.32.1                      2021C-a0t1a-l2y6st::Plugin::Session::Store::File(3)
Impressum