.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Mojolicious::Sessions 3pm" .TH Mojolicious::Sessions 3pm "2012-09-05" "perl v5.14.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Mojolicious::Sessions \- Signed cookie based sessions .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Mojolicious::Sessions; \& \& my $sessions = Mojolicious::Sessions\->new; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Mojolicious::Sessions is a very simple signed cookie based session implementation. All data gets serialized with Mojo::JSON and stored on the client-side, but is protected from unwanted changes with a signature. .SH "ATTRIBUTES" .IX Header "ATTRIBUTES" Mojolicious::Sessions implements the following attributes. .ie n .SS """cookie_domain""" .el .SS "\f(CWcookie_domain\fP" .IX Subsection "cookie_domain" .Vb 2 \& my $domain = $session\->cookie_domain; \& $session = $session\->cookie_domain(\*(Aq.example.com\*(Aq); .Ve .PP Domain for session cookie, not defined by default. .ie n .SS """cookie_name""" .el .SS "\f(CWcookie_name\fP" .IX Subsection "cookie_name" .Vb 2 \& my $name = $session\->cookie_name; \& $session = $session\->cookie_name(\*(Aqsession\*(Aq); .Ve .PP Name of the signed cookie used to store session data, defaults to \&\f(CW\*(C`mojolicious\*(C'\fR. .ie n .SS """cookie_path""" .el .SS "\f(CWcookie_path\fP" .IX Subsection "cookie_path" .Vb 2 \& my $path = $session\->cookie_path; \& $session = $session\->cookie_path(\*(Aq/foo\*(Aq); .Ve .PP Path for session cookie, defaults to \f(CW\*(C`/\*(C'\fR. .ie n .SS """default_expiration""" .el .SS "\f(CWdefault_expiration\fP" .IX Subsection "default_expiration" .Vb 2 \& my $time = $session\->default_expiration; \& $session = $session\->default_expiration(3600); .Ve .PP Time for the session to expire in seconds from now, defaults to \f(CW3600\fR. The expiration timeout gets refreshed for every request. Setting the value to \f(CW0\fR will allow sessions to persist until the browser window is closed, this can have security implications though. For more control you can also use the \&\f(CW\*(C`expires\*(C'\fR session value to set the expiration date to a specific time in epoch seconds. .PP .Vb 2 \& # Expire a week from now \& $c\->session(expires => time + 604800); \& \& # Expire a long long time ago \& $c\->session(expires => 1); .Ve .ie n .SS """secure""" .el .SS "\f(CWsecure\fP" .IX Subsection "secure" .Vb 2 \& my $secure = $session\->secure; \& $session = $session\->secure(1); .Ve .PP Set the secure flag on all session cookies, so that browsers send them only over \s-1HTTPS\s0 connections. .SH "METHODS" .IX Header "METHODS" Mojolicious::Sessions inherits all methods from Mojo::Base and implements the following ones. .ie n .SS """load""" .el .SS "\f(CWload\fP" .IX Subsection "load" .Vb 1 \& $session\->load(Mojolicious::Controller\->new); .Ve .PP Load session data from signed cookie. .ie n .SS """store""" .el .SS "\f(CWstore\fP" .IX Subsection "store" .Vb 1 \& $session\->store(Mojolicious::Controller\->new); .Ve .PP Store session data in signed cookie. .SH "SEE ALSO" .IX Header "SEE ALSO" Mojolicious, Mojolicious::Guides, .