.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" 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" ''
'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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Path::Dispatcher::Declarative 3pm"
.TH Path::Dispatcher::Declarative 3pm "2010-11-02" "perl v5.10.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"
Path::Dispatcher::Declarative \- sugary dispatcher
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    package MyApp::Dispatcher;
\&    use Path::Dispatcher::Declarative \-base;
\&
\&    on score => sub { show_score() };
\&
\&    on [\*(Aqwield\*(Aq, qr/^\ew+$/] => sub { wield_weapon($2) };
\&
\&    rewrite qr/^inv/ => "display inventory";
\&
\&    under display => sub {
\&        on inventory => sub { show_inventory() };
\&        on score     => sub { show_score() };
\&    };
\&
\&    package Interpreter;
\&    MyApp::Dispatcher\->run($input);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Jifty::Dispatcher rocks!
.SH "KEYWORDS"
.IX Header "KEYWORDS"
.SS "dispatcher \-> Dispatcher"
.IX Subsection "dispatcher -> Dispatcher"
Returns the Path::Dispatcher object for this class; the object that the
sugar is modifying. This is useful for adding custom rules through the regular
\&\s-1API\s0, and inspection.
.SS "dispatch path \-> Dispatch"
.IX Subsection "dispatch path -> Dispatch"
Invokes the dispatcher on the given path and returns a
Path::Dispatcher::Dispatch object. Acts as a keyword within the same
package; otherwise as a method (since these declarative dispatchers are
supposed to be used by other packages).
.SS "run path, args"
.IX Subsection "run path, args"
Performs a dispatch then invokes the \*(L"run\*(R" in Path::Dispatcher::Dispatch method
on it.
.SS "on path => sub {}"
.IX Subsection "on path => sub {}"
Adds a rule to the dispatcher for the given path. The path may be:
.IP "a string" 4
.IX Item "a string"
This is taken to mean a single token; creates an
Path::Dispatcher::Rule::Tokens rule.
.IP "an array reference" 4
.IX Item "an array reference"
This is creates a Path::Dispatcher::Rule::Tokens rule.
.IP "a regular expression" 4
.IX Item "a regular expression"
This is creates a Path::Dispatcher::Rule::Regex rule.
.IP "a code reference" 4
.IX Item "a code reference"
This is creates a Path::Dispatcher::Rule::CodeRef rule.
.SS "under path => sub {}"
.IX Subsection "under path => sub {}"
Creates a Path::Dispatcher::Rule::Under rule. The contents of the coderef
should be nothing other \*(L"on\*(R" and \f(CW\*(C`under\*(C'\fR calls.
.SS "then sub { }"
.IX Subsection "then sub { }"
Creates a Path::Dispatcher::Rule::Always rule that will continue on to the
next rule via \f(CW\*(C`next_rule\*(C'\fR
.PP
The only argument is a coderef that processes normally (like on).
.PP
\&\s-1NOTE:\s0 You *can* avoid running a following rule by using \f(CW\*(C`last_rule\*(C'\fR.
.PP
An example:
.PP
.Vb 12
\&    under show => sub {
\&        then {
\&            print "Displaying ";
\&        };
\&        on inventory => sub {
\&            print "inventory:\en";
\&            ...
\&        };
\&        on score => sub {
\&            print "score:\en";
\&            ...
\&        };
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Shawn M Moore, \f(CW\*(C`<sartak at bestpractical.com>\*(C'\fR
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to
\&\f(CW\*(C`bug\-path\-dispatcher\-declarative at rt.cpan.org\*(C'\fR, or through the web interface at
<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Path\-Dispatcher\-Declarative>.
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2008\-2010 Best Practical Solutions.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.