File: README

package info (click to toggle)
libcatalyst-plugin-session-store-file-perl 0.18-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, jessie, jessie-kfreebsd, sid, stretch
  • size: 180 kB
  • ctags: 142
  • sloc: perl: 1,807; makefile: 2
file content (80 lines) | stat: -rw-r--r-- 2,956 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
NAME
    Catalyst::Plugin::Session::Store::File - File storage backend for
    session data.

SYNOPSIS
        use Catalyst qw/Session Session::Store::File Session::State::Foo/;

        MyApp->config->{'Plugin::Session'} = {
            storage => '/tmp/session'
        };

        # ... in an action:
        $c->session->{foo} = 'bar'; # will be saved

DESCRIPTION
    "Catalyst::Plugin::Session::Store::File" is an easy to use storage
    plugin for Catalyst that uses an simple file to act as a shared memory
    interprocess cache. It is based on "Cache::FileCache".

  METHODS
    get_session_data
    store_session_data
    delete_session_data
    delete_expired_sessions
        These are implementations of the required methods for a store. See
        Catalyst::Plugin::Session::Store.

    setup_session
        Sets up the session cache file.

CONFIGURATION
    These parameters are placed in the hash under the "Plugin::Session" key
    in the configuration hash.

    storage
        Specifies the directory root to be used for the sharing of session
        data. The default value will use File::Spec to find the default
        tempdir, and use a file named "MyApp/session/data", where "MyApp" is
        replaced with the appname.

        Note that the file will be created with mode 0640, which means that
        it will only be writeable by processes running with the same uid as
        the process that creates the file. If this may be a problem, for
        example if you may try to debug the program as one user and run it
        as another, specify a directory like "/tmp/session-$>", which
        includes the UID of the process in the filename.

    relative
        Makes the storage path relative to *$c-*path_to>

    namespace
        The namespace associated with this cache. Defaults to an empty
        string if not explicitly set. If set, the session data will be
        stored in a directory called "MyApp/session/data/<namespace">.

    cache_depth
        The number of subdirectories deep to session object item. This
        should be large enough that no session directory has more than a few
        hundred objects. Defaults to 3 unless explicitly set.

    directory_umask
        The directories in the session on the filesystem should be globally
        writable to allow for multiple users. While this is a potential
        security concern, the actual cache entries are written with the
        user's umask, thus reducing the risk of cache poisoning. If you
        desire it to only be user writable, set the 'directory_umask' option
        to '077' or similar. Defaults to '000' unless explicitly set.

SEE ALSO
    Catalyst, Catalyst::Plugin::Session, Cache::FileCache.

AUTHOR
    Sascha Kiefer, esskar@cpan.org

COPYRIGHT AND LICENSE
    Copyright (C) 2005 Sascha Kiefer

    This library is free software; you can redistribute it and/or modify it
    under the same terms as Perl itself.