.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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" ''
.    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 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.
.\"
.\" 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 "Catalyst::ActionRole::NeedsLogin 3pm"
.TH Catalyst::ActionRole::NeedsLogin 3pm "2016-07-29" "perl v5.22.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"
Catalyst::ActionRole::NeedsLogin \- checks if a user is logged in and if not redirects him to login page
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    package MyApp::Controller::NeedsAuth;
\&
\&    use Moose;
\&    use namespace::autoclean;
\&
\&    # One needs to inherit from Catalyst::Controller in order
\&    # to get the Does(\*(AqNeedsLogin\*(Aq) functionality.
\&    BEGIN { extends \*(AqCatalyst::Controller\*(Aq; }
\&
\&    sub inbox : Path Does(\*(AqNeedsLogin\*(Aq) {
\&        # Redirects to /login if not logged in
\&        my ($self, $c) = @_;
\&
\&        $c\->stash\->{template} = "inbox.tt2";
\&
\&        return;
\&    }
\&
\&    sub inbox : Path Does(\*(AqNeedsLogin\*(Aq) :LoginRedirectMessage(\*(AqYour custom Message\*(Aq) {
\&        # Redirects to /login if not logged in\-
\&    }
\&
\&    # Turn on in config
\&    MyApp\->config(\*(AqContoller::Login\*(Aq => { traits => [\*(AqWithRedirect\*(Aq] });
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Provides a ActionRole for forcing the user to login.
.SH "WRAPPED METHODS"
.IX Header "WRAPPED METHODS"
.SS "execute"
.IX Subsection "execute"
If there is no logged-in user, call the \fIlogin_redirect()\fR method in the
\&\f(CW\*(AqLogin\*(Aq\fR controller with the Catalyst context object, \f(CW$c\fR, and the
message specified by the \f(CW\*(C`:LoginRedirectMessage(\*(AqMessage here\*(Aq)\*(C'\fR method
attribute (see the synopsis).
.PP
If there is a user logged-in (i.e: \f(CW\*(C`$c\->user\*(C'\fR is true), execute the body
of the action as it is.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "CatalystX::SimpleLogin::TraitFor::Controller::Login::WithRedirect" 4
.IX Item "CatalystX::SimpleLogin::TraitFor::Controller::Login::WithRedirect"
.PD 0
.IP "CatalystX::SimpleLogin::Controller::Login" 4
.IX Item "CatalystX::SimpleLogin::Controller::Login"
.IP "CatalystX::SimpleLogin::Form::Login" 4
.IX Item "CatalystX::SimpleLogin::Form::Login"
.PD
.SH "AUTHORS"
.IX Header "AUTHORS"
See CatalystX::SimpleLogin for authors.
.SH "LICENSE"
.IX Header "LICENSE"
See CatalystX::SimpleLogin for license.