.\" 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 "MasonX::Request::WithApacheSession 3pm" .TH MasonX::Request::WithApacheSession 3pm "2012-12-01" "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" MasonX::Request::WithApacheSession \- Add a session to the Mason Request object .SH "SYNOPSIS" .IX Header "SYNOPSIS" In your \fIhttpd.conf\fR file: .PP .Vb 5 \& PerlSetVar MasonRequestClass MasonX::Request::WithApacheSession \& PerlSetVar MasonSessionCookieDomain .example.com \& PerlSetVar MasonSessionClass Apache::Session::File \& PerlSetVar MasonSessionDirectory /tmp/sessions/data \& PerlSetVar MasonSessionLockDirectory /tmp/sessions/locks .Ve .PP Or when creating an ApacheHandler object: .PP .Vb 8 \& my $ah = \& HTML::Mason::ApacheHandler\->new \& ( request_class => \*(AqMasonX::Request::WithApacheSession\*(Aq, \& session_cookie_domain => \*(Aq.example.com\*(Aq, \& session_class => \*(AqApache::Session::File\*(Aq, \& session_directory => \*(Aq/tmp/sessions/data\*(Aq, \& session_lock_directory => \*(Aq/tmp/sessions/locks\*(Aq, \& ); .Ve .PP In a component: .PP .Vb 2 \& $m\->session\->{foo} = 1; \& if ( $m\->session\->{bar}{baz} > 1 ) { ... } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module integrates \f(CW\*(C`Apache::Session\*(C'\fR into Mason by adding methods to the Mason Request object available in all Mason components. .PP Any subrequests created by a request share the same session. .SH "USAGE" .IX Header "USAGE" To use this module you need to tell Mason to use this class for requests. This can be done in one of two ways. If you are configuring Mason via your \fIhttpd.conf\fR file, simply add this: .PP .Vb 1 \& PerlSetVar MasonRequestClass MasonX::Request::WithApacheSession .Ve .PP If you are using a \fIhandler.pl\fR file, simply add this parameter to the parameters given to the ApacheHandler constructor: .PP .Vb 1 \& request_class => \*(AqMasonX::Request::WithApacheSession\*(Aq .Ve .SH "METHODS" .IX Header "METHODS" This class adds two methods to the Request object. .IP "\(bu" 4 session .Sp This method returns a hash tied to the \f(CW\*(C`Apache::Session\*(C'\fR class. .IP "\(bu" 4 delete_session .Sp This method deletes the existing session from persistent storage. If you are using the built-in cookie mechanism, it also deletes the cookie in the browser. .SH "CONFIGURATION" .IX Header "CONFIGURATION" This module accepts quite a number of parameters, most of which are simply passed through to \f(CW\*(C`Apache::Session::Wrapper\*(C'\fR. For this reason, you are advised to familiarize yourself with the \&\f(CW\*(C`Apache::Session::Wrapper\*(C'\fR documentation before attempting to configure this module. .PP If you are creating your own Interp/ApacheHandler/CGIHandler object in a script or module, you should pass this object the parameters intended for \f(CW\*(C`Apache::Session::Wrapper\*(C'\fR, prefixed with \*(L"session_\*(R". So to set the \*(L"class\*(R" parameter for \f(CW\*(C`Apache::Session::Wrapper\*(C'\fR, you pass in a \*(L"session_class\*(R" parameter. .PP If you are configuring Mason via your \fIhttpd.conf\fR file, you should pass the \*(L"StudlyCaps\*(R" version of the name, prefixed by \*(L"MasonSession\*(R". So the \*(L"class\*(R" parameter would be \*(L"MasonSessionClass\*(R". .PP A few examples: .IP "\(bu" 4 class becomes session_class / MasonSessionClass .IP "\(bu" 4 always_write becomes session_always_write / MasonSessionAlwaysWrite .PP When running under ApacheHandler or CGIHandler, this module takes care of passing the \*(L"header_object\*(R" and \*(L"param_object\*(R" parameters to \&\f(CW\*(C`Apache::Session::Wrapper\*(C'\fR. These will be the \f(CW\*(C`Apache::Request\*(C'\fR or \&\f(CW\*(C`CGI.pm\*(C'\fR objects, as applicable. .PP The \*(L"cookie_name\*(R" parameter defaults to \&\*(L"MasonX-Request-WithApacheSession-cookie\*(R" when you use this module, instead of \*(L"Apache-Session-Wrapper-cookie\*(R". .PP Finally, for backwards compatiblity, this module accepts a \&\*(L"session_args_param\*(R" parameter, which corresponds to the \*(L"param_name\*(R" parameter for \f(CW\*(C`Apache::Session::Wrapper\*(C'\fR. .SH "SUPPORT" .IX Header "SUPPORT" As can be seen by the number of parameters above, \f(CW\*(C`Apache::Session\*(C'\fR has \fBway\fR too many possibilities for me to test all of them. This means there are almost certainly bugs. .PP Bug reports and requests for help should be sent to the mason-users list. See http://www.masonhq.com/resources/mailing_lists.html for more details. .SH "AUTHOR" .IX Header "AUTHOR" Dave Rolsky, .SH "SEE ALSO" .IX Header "SEE ALSO" HTML::Mason