.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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::DispatchType 3pm"
.TH Catalyst::DispatchType 3pm "2019-01-19" "perl v5.28.1" "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::DispatchType \- DispatchType Base Class
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
See Catalyst.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is an abstract base class for Dispatch Types.
.PP
From a code perspective, dispatch types are used to find which actions
to call for a given request \s-1URL.\s0  Website authors will typically work
with them via subroutine names attributes; a description of dispatch
at the attribute/URL level is given in Catalyst::Manual::Intro.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "$self\->list($c)"
.el .SS "\f(CW$self\fP\->list($c)"
.IX Subsection "$self->list($c)"
abstract method, to be implemented by dispatchtypes. Called to display
info in debug log.
.ie n .SS "$self\->match( $c, $path )"
.el .SS "\f(CW$self\fP\->match( \f(CW$c\fP, \f(CW$path\fP )"
.IX Subsection "$self->match( $c, $path )"
abstract method, to be implemented by dispatchtypes. Returns true if the
dispatch type matches the given path
.ie n .SS "$self\->register( $c, $action )"
.el .SS "\f(CW$self\fP\->register( \f(CW$c\fP, \f(CW$action\fP )"
.IX Subsection "$self->register( $c, $action )"
abstract method, to be implemented by dispatchtypes. Takes a
context object and a Catalyst::Action object.
.PP
Should return true if it registers something, or false otherwise.
.ie n .SS "$self\->uri_for_action( $action, \e@captures )"
.el .SS "\f(CW$self\fP\->uri_for_action( \f(CW$action\fP, \e@captures )"
.IX Subsection "$self->uri_for_action( $action, @captures )"
abstract method, to be implemented by dispatchtypes. Takes a
Catalyst::Action object and an arrayref of captures, and should
return either a \s-1URI\s0 part which if placed in \f(CW$c\fR\->req\->path would cause
\&\f(CW$self\fR\->match to match this action and set \f(CW$c\fR\->req\->captures to the supplied
arrayref, or undef if unable to do so.
.ie n .SS "$self\->expand_action"
.el .SS "\f(CW$self\fP\->expand_action"
.IX Subsection "$self->expand_action"
Default fallback, returns nothing. See Catalyst::Dispatcher for more info
about expand_action.
.SH "AUTHORS"
.IX Header "AUTHORS"
Catalyst Contributors, see Catalyst.pm
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
This library is free software. You can redistribute it and/or modify it under
the same terms as Perl itself.