.\" -*- 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::Common::PSGI::Request 3pm"
.TH Lemonldap::NG::Common::PSGI::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::Common::PSGI::Request \- HTTP request object for Lemonldap::NG
PSGIs
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  package My::PSGI;
\&
\&  use base Lemonldap::NG::Common::PSGI;
\&
\&  # See Lemonldap::NG::Common::PSGI
\&  ...
\&
\&  sub handler {
\&    my ( $self, $req ) = @_;
\&    # Do something and return a PSGI response
\&    # NB: $req is a Lemonldap::NG::Common::PSGI::Request object
\&    if ( $req\->accept eq \*(Aqtext/plain\*(Aq ) { ... }
\&
\&    return [ 200, [ \*(AqContent\-Type\*(Aq => \*(Aqtext/plain\*(Aq ], [ \*(AqBody lines\*(Aq ] ];
\&  }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This package provides HTTP request objects used by Lemonldap::NG PSGIs. It
contains common accessors to work with request. Note that it inherits from
Plack::Request.
.SH METHODS
.IX Header "METHODS"
All methods of Plack::Request are available.
Lemonldap::NG::Common::PSGI::Request adds the following methods:
.SS accept
.IX Subsection "accept"
\&'Accept' header content.
.SS encodings
.IX Subsection "encodings"
\&'Accept\-Encoding' header content.
.SS error
.IX Subsection "error"
Used to store error value (usually a Lemonldap::NG::Portal::Main::Constants
constant).
.SS jsonBodyToObj
.IX Subsection "jsonBodyToObj"
Get the content of a JSON POST request as Perl object.
.SS languages
.IX Subsection "languages"
\&'Accept\-Language header content.
.SS hostname
.IX Subsection "hostname"
\&'Host' header content.
.SS read-body
.IX Subsection "read-body"
Since \fBbody()\fR methods returns an IO::Handle object, this method reads and
return the request content as string.
.SS respHeaders
.IX Subsection "respHeaders"
Accessor to 'respHeaders' property. It is used to store headers that have to
be pushed in response (see Lemonldap::NG::Common::PSGI).
.PP
Be careful, it contains an array reference, not a hash one because headers
can be multi-valued.
.PP
Example:
.PP
.Vb 4
\&  # Set headers
\&  $req\->respHeaders( "Location" => "http://x.y.z/", Etag => "XYZ", );
\&  # Add header
\&  $req\->respHeaders\->{"X\-Key"} = "Value";
.Ve
.SS spliceHdrs
.IX Subsection "spliceHdrs"
Returns headers array and flush it.
.ie n .SS "set_param( $key, $value )"
.el .SS "set_param( \f(CW$key\fP, \f(CW$value\fP )"
.IX Subsection "set_param( $key, $value )"
Plack::Request \fBparam()\fR method is read-only. This method can be used to
modify a GET parameter value
.SS uri
.IX Subsection "uri"
REQUEST_URI environment variable decoded.
.SS user
.IX Subsection "user"
REMOTE_USER environment variable. It contains username when a server
authentication is done.
.SS userData
.IX Subsection "userData"
Hash reference to the session information (if app inherits from
Lemonldap::NG::Handler::PSGI or any other handler PSGI package). If no
session information is available, it contains:
.PP
.Vb 1
\&  { _whatToTrace => <REMOTE\-USER value> }
.Ve
.SS wantJSON
.IX Subsection "wantJSON"
Return true if current request ask JSON content (verify that "Accept" header
contains "application/json" or "text/json").
.SH "SEE ALSO"
.IX Header "SEE ALSO"
<http://lemonldap\-ng.org/>, Lemonldap::NG::Common::PSGI,
Lemonldap::NG::Hander::PSGI, Plack::Request,
Lemonldap::NG::Portal::Main::Constants,
.SH AUTHORS
.IX Header "AUTHORS"
.IP "LemonLDAP::NG team <http://lemonldap\-ng.org/team>" 4
.IX Item "LemonLDAP::NG team <http://lemonldap-ng.org/team>"
.SH "BUG REPORT"
.IX Header "BUG REPORT"
Use OW2 system to report bug or ask for features:
<https://gitlab.ow2.org/lemonldap\-ng/lemonldap\-ng/issues>
.SH DOWNLOAD
.IX Header "DOWNLOAD"
Lemonldap::NG is available at
<https://lemonldap\-ng.org/download>
.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 <http://www.gnu.org/licenses/>.