.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 >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 "Catalyst::Plugin::SubRequest 3pm"
.TH Catalyst::Plugin::SubRequest 3pm "2021-01-04" "perl v5.32.0" "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::Plugin::SubRequest \- Make subrequests to actions in Catalyst
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Catalyst \*(AqSubRequest\*(Aq;
\&
\&    my $res_body = $c\->subreq(\*(Aq/test/foo/bar\*(Aq, { template => \*(Aqmagic.tt\*(Aq });
\&
\&    my $res_body = $c\->subreq( {
\&       path            => \*(Aq/test/foo/bar\*(Aq,
\&       body            => $body
\&    }, {
\&       template        => \*(Aqmagic.tt\*(Aq
\&    });
\&
\&    # Get the full response object
\&    my $res = $c\->subreq_res(\*(Aq/test/foo/bar\*(Aq, {
\&        template => \*(Aqmailz.tt\*(Aq
\&    }, {
\&        param1   => 23
\&    });
\&    $c\->log\->warn( $res\->content_type );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Make subrequests to actions in Catalyst. Uses the  catalyst
dispatcher, so it will work like an external url call.
Methods are provided both to get the body of the response and the full
response (Catalyst::Response) object.
.SH "METHODS"
.IX Header "METHODS"
.IP "subreq [path as string or hash ref], [stash as hash ref], [parameters as hash ref]" 4
.IX Item "subreq [path as string or hash ref], [stash as hash ref], [parameters as hash ref]"
.PD 0
.IP "subrequest" 4
.IX Item "subrequest"
.IP "sub_request" 4
.IX Item "sub_request"
.PD
Takes a full path to a path you'd like to dispatch to.
.Sp
If the path is passed as a hash ref then it can include body, action,
match and path.
.Sp
An optional second argument as hashref can contain data to put into the
stash of the subrequest.
.Sp
An optional third argument as hashref can contain data to pass as
parameters to the subrequest.
.Sp
Returns the body of the response.
.IP "subreq_res [path as string or hash ref], [stash as hash ref], [parameters as hash ref]" 4
.IX Item "subreq_res [path as string or hash ref], [stash as hash ref], [parameters as hash ref]"
.PD 0
.IP "subrequest_response" 4
.IX Item "subrequest_response"
.IP "sub_request_response" 4
.IX Item "sub_request_response"
.PD
Like \f(CW\*(C`sub_request()\*(C'\fR, but returns a full Catalyst::Response object.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Catalyst.
.SH "AUTHORS"
.IX Header "AUTHORS"
Marcus Ramberg, \f(CW\*(C`mramberg@cpan.org\*(C'\fR
.PP
Tomas Doran (t0m) \f(CW\*(C`bobtfish@bobtfish.net\*(C'\fR
.SH "MAINTAINERS"
.IX Header "MAINTAINERS"
Eden Cardim (edenc) \f(CW\*(C`eden@insoli.de\*(C'\fR
.SH "THANK YOU"
.IX Header "THANK YOU"
\&\s-1SRI,\s0 for writing the awesome Catalyst framework
.PP
\&\s-1MIYAGAWA,\s0 for writing the awesome Plack toolkit
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2005 \- 2011
the Catalyst::Plugin::SubRequest \*(L"\s-1AUTHORS\*(R"\s0
as listed above.
.SH "LICENSE"
.IX Header "LICENSE"
This program is free software, you can redistribute it and/or modify it under
the same terms as Perl itself.