.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds C`
. ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Lemonldap::NG::Portal::Main::Request 3pm"
.TH Lemonldap::NG::Portal::Main::Request 3pm 2024-02-07 "perl v5.38.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
Lemonldap::NG::Portal::Main::Request \- HTTP request object used in LLNG
portal methods.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 6
\& # Somewhere in a plugin...
\& sub run {
\& my ( $self, $req ) = @_;
\& # $req is a Lemonldap::NG::Portal::Main::Request object
\& ...
\& }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Lemonldap::NG::Portal::Main::Request extends
Lemonldap::NG::Common::PSGI::Request to add all parameters needed to manage
portal jobs.
.SH METHODS
.IX Header "METHODS"
.SS Accessors
.IX Subsection "Accessors"
\fR\f(BIsteps()\fR\fI\fR
.IX Subsection "steps()"
.PP
Stack of methods to call for this requests. It can be modified to change
authentication process
.PP
\fR\f(BIdata()\fR\fI\fR
.IX Subsection "data()"
.PP
Free hash ref where plugins can store their data (during one request). Using it
is a LLNG best practice
.PP
\fIpdata\fR
.IX Subsection "pdata"
.PP
Free hash ref where plugins can store some persistent data: data are kept
during auth process and cleaned after successful authentication, except if
\&\f(CW\*(C`$req\->pdata\->{keepPdata}\*(C'\fR is set to an array of values. In this
case, module that has set these values must remove them after its job ends.
.PP
\fIUser information\fR
.IX Subsection "User information"
.PP
\fBid()\fR
.IX Subsection "id()"
.PP
Session id (main cookie value).
.PP
\fBsessionInfo()\fR
.IX Subsection "sessionInfo()"
.PP
Hash ref that will be stored in session DB.
.PP
\fBuser()\fR
.IX Subsection "user()"
.PP
Username given by authentication module, used by userDB module.
.PP
\fR\f(BImustRedirect()\fR\fI\fR
.IX Subsection "mustRedirect()"
.PP
Boolean to indicate that response must be a redirection (used for example when
request is a POST).
.PP
\fIurlNotBase64\fR
.IX Subsection "urlNotBase64"
.PP
Boolean to indicate that url isn't Base64 encoded.
.SS "Other methods"
.IX Subsection "Other methods"
\fR\f(BIinfo()\fR\fI\fR
.IX Subsection "info()"
.PP
Store info to display in response.
.PP
\fR\f(BImenuError()\fR\fI\fR
.IX Subsection "menuError()"
.PP
\fR\f(BInotification()\fR\fI\fR
.IX Subsection "notification()"
.PP
see notification plugin.
.PP
\fR\f(BIerrorType()\fR\fI\fR
.IX Subsection "errorType()"
.PP
Returns positive/warning/negative depending on value stored in error property.
.SS "Cookie methods"
.IX Subsection "Cookie methods"
.ie n .IP "addCookie(string $cookie): add cookie in $req response headers. String is a complete cookie string, ex: ""lemonldap=xxx""" 4
.el .IP "addCookie(string \f(CW$cookie\fR): add cookie in \f(CW$req\fR response headers. String is a complete cookie string, ex: ""lemonldap=xxx""" 4
.IX Item "addCookie(string $cookie): add cookie in $req response headers. String is a complete cookie string, ex: ""lemonldap=xxx"""
.PD 0
.ie n .IP "delCookie(string $cookieName): remove cookie from $req response headers. It doesn't remove navigator cookie but remove a ""Set-Cookie"" header if value match ""ltcookieNamegt=...""" 4
.el .IP "delCookie(string \f(CW$cookieName\fR): remove cookie from \f(CW$req\fR response headers. It doesn't remove navigator cookie but remove a ""Set-Cookie"" header if value match ""ltcookieNamegt=...""" 4
.IX Item "delCookie(string $cookieName): remove cookie from $req response headers. It doesn't remove navigator cookie but remove a ""Set-Cookie"" header if value match ""ltcookieNamegt=..."""
.PD
.SH "SEE ALSO"
.IX Header "SEE ALSO"
, Lemonldap::NG::Common::PSGI::Request
.SH AUTHORS
.IX Header "AUTHORS"
.IP "LemonLDAP::NG team " 4
.IX Item "LemonLDAP::NG team "
.SH "BUG REPORT"
.IX Header "BUG REPORT"
Use OW2 system to report bug or ask for features:
.SH DOWNLOAD
.IX Header "DOWNLOAD"
Lemonldap::NG is available at
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
See COPYING file for details.
.PP
This library is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program. If not, see .